自托管 Sphinx 文档中的多个版本
Multiple versions in self hosted Sphinx documentation
我正在尝试为自托管的 GitLab 项目构建文档。该文档将托管在 GitLab 页面中,并且会有不同的版本。感谢 ,我想出了如何在 GitLab 页面上托管多个版本。
我现在的问题是如何访问这些版本。
我想使用 ReadTheDocs 主题,它似乎是在考虑到这一点的情况下构建的:
如何访问和修改该导航菜单?我在文档中找不到任何内容。
(编辑: 刚知道那个菜单的名字是 flyout)
如果这不可能,我想以某种方式在左侧面板上添加一个部分(例如经典主题上的 html_sidebars
),因为我已经构建了一个脚本来获取版本链接。
我真的只需要一种方法来向栏中添加一个部分。
我的解决方案
由于@Steve Piercy 在评论中提到在 RTD 自托管主题中无法弹出弹出窗口,我尝试个性化左侧边栏以添加版本链接。
与 classic 主题(以及我提到的 html_sidebars
)不同,似乎无法配置显示的内容。你可以做的是add customised javascript and css。所以我创建了一个小脚本,它添加了一个新的无序列表,其中包含指向目录顶部版本的链接。
我更愿意采用另一种方法,因为它是 hacky 并且它使用硬编码的 css class 名称(可能随时更改),但这是我唯一能做的想出并且工作正常。
如果有人需要有关解决方案的更多详细信息,我可以提供。
我正在尝试为自托管的 GitLab 项目构建文档。该文档将托管在 GitLab 页面中,并且会有不同的版本。感谢
我现在的问题是如何访问这些版本。
我想使用 ReadTheDocs 主题,它似乎是在考虑到这一点的情况下构建的:
如何访问和修改该导航菜单?我在文档中找不到任何内容。
(编辑: 刚知道那个菜单的名字是 flyout)
如果这不可能,我想以某种方式在左侧面板上添加一个部分(例如经典主题上的 html_sidebars
),因为我已经构建了一个脚本来获取版本链接。
我真的只需要一种方法来向栏中添加一个部分。
我的解决方案
由于@Steve Piercy 在评论中提到在 RTD 自托管主题中无法弹出弹出窗口,我尝试个性化左侧边栏以添加版本链接。
与 classic 主题(以及我提到的 html_sidebars
)不同,似乎无法配置显示的内容。你可以做的是add customised javascript and css。所以我创建了一个小脚本,它添加了一个新的无序列表,其中包含指向目录顶部版本的链接。
我更愿意采用另一种方法,因为它是 hacky 并且它使用硬编码的 css class 名称(可能随时更改),但这是我唯一能做的想出并且工作正常。
如果有人需要有关解决方案的更多详细信息,我可以提供。