ReadTheDocs + Sphinx + setuptools_scm:如何?

问题描述 投票:0回答:1

我有一个项目,可以通过git标签管理版本。然后,我使用setuptools_scm在我的setup.py中获取此信息,并且还生成了一个文件(_version.py),该文件在为pip生成转盘时会包括在内。

git未能跟踪此文件,因为:

  1. 它具有git可以收集的相同信息>
  2. 这会产生一个循环情况,在这种情况下,安装轮子会修改版本,从而更改源并生成新版本
  3. 现在,当我构建文档时,很自然地可以从_version.py获取此版本,并且在本地都可以很好地工作。

但是,当我尝试在ReadTheDocs中执行此操作时,文档构建失败,因为_version.py未跟踪git,因此从存储库中获取源代码时,ReadTheDocs找不到它。


EDIT

:我已经尝试使用duplicate中建议的方法,该方法与文档中的setuptools_scm表示相同,即,在docs/conf.py中使用:
from pkg_resources import get_distribution
__version__ = get_distribution('numeral').version
... # I use __version__ to define Sphinx variables

但是我得到:

pkg_resources.DistributionNotFound:找不到'数字'分发,应用程序需要此分发

(再次,在本地构建文档可以正常工作。)


我该如何解决这个问题而不求助于在两个地方维护版本号?

我有一个项目,可以通过git标签管理版本。然后,我使用setuptools_scm在setup.py中获取此信息,并生成一个文件(_version.py),当...

python python-sphinx setuptools read-the-docs
1个回答
0
投票
© www.soinside.com 2019 - 2024. All rights reserved.