TL; DR :
如何使文档阅读者在文档页面的左上角显示实际版本号而不是单词“ latest”或“ stable”?
为了两全其美,应该说“最新的v0.1.2”。
详细信息:
我有一个Python项目,我将文档发布在read-the-docs上。我还使用没有sphinx_rtd_theme
的{{1}}。
在我的狮身人面像html_theme_options
中,我有:
conf.py
在本地生成文档时,按预期,我在项目名称的左上角看到了版本号。
但是,当我查看文档阅读文档时,此版本号将替换为“最新”。
很高兴知道文档是最新版本!但是最好知道记录的是哪个版本。
这似乎是预期的默认行为。例如。看一下https://twine.readthedocs.io/en/latest/-有两个可用的版本,...
import my_module
version = my_module.__version__
release = version
...
和latest
,但是没有(简便)的方法来告诉任何一个的实际版本号。
这很重要:每次提交的版本号都不相同。它采用行为良好的stable
格式,并存储在显式x.y.z
文件中。该文件是version.py
软件包的一部分,但从未检入;而是由sdist
从版本控制系统生成的。最新标签是setup.py
,主分支上的标签提交距离为x.y
。