我有两个独立的Github repos,一个用于文档,另一个由开发人员维护。
单据回购(https://gihub.com/doc)没有任何标记,但只有本地分支。
实际开发商回购(https://github.com/dev)有许多标签和分支。
我需要在Sphinxindex.html
左侧导航栏上显示不同的标签/版本,该导航栏基本上根据开发的功能区分内容。
当前功能:
我的ReadtheDocs被导入到Github,ReadtheDocs文档站点URL只显示latest
版本,如:
https://mysite-hosted.com/en/latest/
我的要求:
我需要一些类似的东西:
- https://mysite-hosted.com/en/v1.0/
- https://mysite-hosted.com/en/v1.1/
其中v1.0
和v1.1
应显示在导航栏中。
我尝试了什么:
-
我已经安装了https://pypi.org/project/sphinx-multiversion/扩展,并尝试使用命令
sphinx-multiversion . build/html
在本地构建项目。在打开index.html
页面时,我看不到导航窗格上显示任何标记/分支。 -
因此,为了自定义HTML模板,我根据文档添加了包含以下内容的
docs/_templates/versioning.html
文件。导航上仍然没有任何内容。{% if versions %} <h3>{{ _('Branches') }}</h3> <ul> {%- for item in versions.branches %} <li><a href="{{ item.url }}">{{ item.name }}</a></li> {%- endfor %} </ul> <h3>{{ _('Tags') }}</h3> <ul> {%- for item in versions.tags %} <li><a href="{{ item.url }}">{{ item.name }}</a></li> {%- endfor %} </ul> {% endif %} <h3>Versions</h3> <ul> {%- for item in versions %} <li><a href="{{ item.url }}">{{ item.name }}</a></li> {%- endfor %} </ul>
步骤中缺少什么?查看标签/版本的正确流程是什么?
你是这样设置conf.py
的吗?
html_sidebars = {
'**': ["versioning.html"]
}
我仍然在挣扎,因为index.html
在侧边栏中似乎没有小部件!