狮身人面像ReadTheDocs主题

时间:2016-02-13 16:58:40

标签: python-sphinx read-the-docs

我想禁用ReadTheDocs主题的顶部导航栏。对于其他主题,例如classic,它只是一个选项

html_theme = "classic"
html_theme_options = {
    "showrelbartop": False
}

如何修改阅读文档主题以禁用此顶部导航栏?

修改 使用make html处理源文件后,我必须删除html文件中的这些行

<div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="index.html">Docs</a> &raquo;</li>
    <li></li>
      <li class="wy-breadcrumbs-aside">
      </li>
  </ul>
  <hr/>
</div>

获得预期结果。在使用make html

编译源代码之前是否可以获得此结果

2 个答案:

答案 0 :(得分:2)

我假设你引用了面包屑(breadcrumbs.html)。您只需打开主模板文件 - layout.html - 并删除或注释掉以下行:

{% include "breadcrumbs.html" %}

答案 1 :(得分:1)

一个老问题,但我也需要这个。一个比目前接受的更简单的答案,适用于 Sphinx==3.5.3 和 sphinx-rtd-theme==0.5.2 是:

  • docs/_templates/ 中,创建一个名为 breadcrumbs.html
  • 在该文件中,编写像 <!-- Empty override file take the place of env/lib/python3.8/site-packages/sphinx_rtd_theme/breadcrumbs.html, which generates the top nav breadcrumbs. --> 这样的 html 注释。

重建,你就完成了。