setuptools - readthedocs和setuptools scm版本错误

Question

我刚刚更新了一个包以使用 setuptools_scm，并发现 readthedocs 中的版本号错误。

http://sshuttle.readthedocs.org/en/v0.77/显示:

Version: 0.78.dev0+ng083293e.d20160304

但是，由于版本 083293e 具有 0.77 标签，因此版本字符串应该只是 0.77

看起来 readthedocs 可能会在构建之前对我的源代码进行更改。

我查看了 readthedocs 构建日志，它似乎在某个阶段具有正确的版本 (0.77)，但这是在构建文档之前。

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

构建日志在构建文档时不会提及版本。

这个问题能解决吗？

谢谢

Answer 1

我看到您正在构建 this project .

显然，在确定版本之前，某些东西正在改变存储库状态。您可以在自己构建文档之前通过更改其中一个文件来复制类似的行为:

(sshuttle) $ python setup.py --version
0.77
(sshuttle) $ cat >> setup.py
# a comment
(sshuttle) $ python setup.py --version
0.78.dev0+ng083293e.d20160403

在阅读文档文档中，有一个 description of the process .

在那里，您可以看到 RTD 执行的步骤，即 (a) 运行 setup.py install 然后 (b) 在requirements.txt 中安装需求。

我已经确认这些步骤都不应该改变存储库状态。

但是，它没有解释该“版本”的来源，或者 update_imported_docs 的作用。我怀疑问题在于阅读文档正在修改存储库的一些微妙的事情。

这是one place where the conf.py file gets modified .

也许将 docs/conf.py 添加到您的 .gitignore 将允许忽略这些更改，从而在计算项目版本时不会弄脏您的工作状态。