Search code examples
setuptoolsread-the-docssetuptools-scm

readthedocs and setuptools scm version wrong

I have a package I just updated to use setuptools_scm and found the version number is wrong in readthedocs.

http://sshuttle.readthedocs.org/en/v0.77/ shows:

Version: 0.78.dev0+ng083293e.d20160304

however as version 083293e has the 0.77 tag, the version string should be just 0.77

It looks like readthedocs might be making changes to my source code before building.

I have looked at the readthedocs build logs, and it seems to have the correct version at one stage (0.77), however this is before it builds the documentation.

Processing dependencies for sshuttle==0.77
Finished processing dependencies for sshuttle==0.77

The build logs don't mention the version while building the documentation.

Is it possible to solve this?

Thanks

Solution

  • The documentation for setuptools_scm now has instructions on how to use with readthedocs:

    It is discouraged to use setuptools_scm from sphinx itself, instead use pkg_resources after editable/real installation:

    from pkg_resources import get_distribution
release = get_distribution('myproject').version
# for example take major/minor
version = '.'.join(release.split('.')[:2])

    The underlying reason is, that services like readthedocs sometimes change the workingdirectory for good reasons and using the installed metadata prevents using needless volatile data there.

    This avoids the need to use kluges as per the other answer.