Read the Docs 功能#

此主题支持 Read the Docs,这是在科学 Python 社区中流行的文档托管服务。

版本切换器#

Read the Docs 默认情况下为项目提供版本切换器,作为可以禁用的 弹出菜单 的一部分。

这意味着如果您在 Read the Docs 上托管启用 PyData Sphinx 主题的站点,您有以下三种选择:

  1. 仅使用 Read the Docs 版本切换器。如果您之前启用了此主题提供的版本切换器,则必须禁用它。

  2. 仅使用此主题的版本切换器。您必须通过访问项目的 Read the Docs 仪表板 来禁用 Read the Docs 版本切换器。然后转到 设置 > 附加组件 > 弹出菜单 并取消选中“启用弹出菜单”框。

  3. 不推荐:同时使用两个版本切换器。

请注意,这两个版本切换器在功能上并不等同。例如,Read the Docs 弹出菜单除了版本切换器外还提供翻译切换器。另一方面,Read the Docs 切换器的样式与此主题的外观和感觉不匹配。还有其他差异。

在侧边栏中添加 ethical 广告#

如果您在 ReadTheDocs 上托管您的文档,您应该考虑为他们的 ethical 广告 添加明确的位置。这些是来自 ethical 公司的非跟踪广告,它们帮助 ReadTheDocs 维持自身及其免费服务。

Ethical 广告默认添加到您的侧边栏中。如果您手动更新侧边栏,请确保将 sidebar-ethical-ads.html 模板添加到您的列表中。例如:

html_sidebars = {
    "**": ["search-field.html", "sidebar-nav-bs.html", "sidebar-ethical-ads.html"]
}