Skip to content

Readthedocs points to wrong version of source code for .postN release #837

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
murrayrm opened this issue Dec 31, 2022 · 1 comment · Fixed by #880
Closed

Readthedocs points to wrong version of source code for .postN release #837

murrayrm opened this issue Dec 31, 2022 · 1 comment · Fixed by #880
Assignees
@murrayrm
Milestone
0.9.4

Comments

@murrayrm
Copy link
Member

I though I fixed this in #836, but it looks like readthedocs is still pointing to the main branch for v0.9.3.post2. Not a big deal, but flagging it here for fixing in the next release.
@murrayrm murrayrm added this to the 0.9.4 milestone Dec 31, 2022
@murrayrm
Copy link
Member Author

murrayrm commented Jan 13, 2023 •
edited
Loading

I did a bit of looking into this. Here's what I think is happening:

  • In the build process, readthedocs checks out the code using the command
    git clone --no-single-branch --depth 50 https://github.com/python-control/python-control .
  • This gets the latest code, but that code does not have the version set => we end up with __version__ being set to 'dev'.
  • In doc/conf.py, if version is 'dev' then the source code links point to the main branch.

Possible fixes:

  • Checkout the code via pip
  • Figure out if there is a tag on the commit and use that to set the version number
  • (something smarter than these...)

@murrayrm murrayrm self-assigned this Mar 26, 2023
@murrayrm murrayrm mentioned this issue Mar 27, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@murrayrm murrayrm

Labels
None yet
Projects
None yet
Milestone
0.9.4
Development

Successfully merging a pull request may close this issue.

Small fixes for 0.9.4 release murrayrm/python-control
1 participant
@murrayrm