【问题标题】:Multiple versions in self hosted Sphinx documentation自托管 Sphinx 文档中的多个版本
【发布时间】:2020-03-02 11:08:36
【问题描述】:

我正在尝试为自托管 GitLab 项目构建文档。该文档将托管在 GitLab 页面中,并且会有不同的版本。感谢this answer,我知道如何在 GitLab 页面上托管多个版本。

我现在的问题是如何访问这些版本。

我想使用 ReadTheDocs 主题,它似乎是基于这一点构建的:

如何访问和修改该导航菜单?我无法在文档中找到任何内容。

编辑:刚刚得知那个菜单的名字是flyout

如果这不可能,我想以某种方式在左侧面板上添加一个部分(如经典主题上的 html_sidebars),因为我已经构建了一个脚本来获取版本的链接。

我真的只需要一种向栏添加部分的方法。

【问题讨论】:

  • 浮出控件不是 RTD 主题的一部分,但它是 RTD 产品的一部分。它是为每个主题插入的,除了管理有关项目的版本和其他属性外,不允许用户控件对其进行自定义。

标签: python python-sphinx read-the-docs


【解决方案1】:

我的解决方案

由于@Steve Piercy 在评论中提到无法在 RTD 自托管主题中弹出弹出窗口,因此我尝试个性化左侧边栏以添加版本链接。

与经典主题(我提到的html_sidebars)不同,似乎无法配置显示的内容。你可以做的是add customised javascript and css。所以我创建了一个小脚本,它在目录顶部添加了一个新的无序列表,其中包含指向版本的链接。

我宁愿采用另一种方法,因为它很老套,而且它使用硬编码的 css 类名(可能随时更改),但这是我唯一能想出的并且可以正常工作的方法。

如果有人需要有关解决方案的更多详细信息,我可以提供。

【讨论】:

    猜你喜欢
    • 2022-09-23
    • 2011-12-12
    • 1970-01-01
    • 1970-01-01
    • 2022-01-14
    • 1970-01-01
    • 2016-11-02
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多