Read the Docs 功能

此主题提供对 Read the Docs 的支持，这是一个在科学 Python 社区中流行的文档托管服务。

版本切换器

托管在 Read the Docs 上的项目可以使用 Read the Docs 提供的版本切换器，而不是 此主题提供的版本切换器。此主题将自动检测它的存在，并将它放置在主侧边栏内的 rtd-footer-container 节点中。

警告

当主侧边栏隐藏时，Read the Docs 版本切换器将被隐藏（有关何时可能自动隐藏主侧边栏以及如何故意隐藏它的讨论，请参阅 此部分）。我们打算使 Read the Docs 切换器放置更加灵活；您可以在 此问题 中跟踪这方面的进展。这个问题不适用于 弹出式插件 提供的版本切换器，该插件可以通过项目的设置启用。

在侧边栏中添加道德广告

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

默认情况下，道德广告会添加到您的侧边栏中。为了确保在您手动更新侧边栏时它们仍然存在，请确保将 sidebar-ethical-ads.html 模板添加到您的列表中。例如

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