Skip to content

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

Description

@murrayrm

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.

Activity

  1. added this to the 0.9.4 milestone on Dec 31, 2022
  2. murrayrm commented on Jan 13, 2023

    @murrayrm
    MemberAuthor

    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...)
  3. self-assigned this
    on Mar 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions