Toctree激活侧栏上的当前页面和主页

时间:2018-07-22 08:06:16

标签: python python-3.x documentation python-3.5 python-sphinx

de index.rst上没有问题,如下所示:

Sphinx RTD doc home page

但是,当我转到另一页时,以我的情况为annotation-module.rst,边栏会选择并显示indexannotation-module,如下所示:

Sphinx RTD sidebar shows both menus

但是,我只想激活注释模块页并显示其子部分。

我的conf.py仅通过查找html_theme环境变量来使用READTHEDOCS,如下所示:

if not on_rtd:  # only import and set the theme if we're building docs locally
    try:
        import sphinx_rtd_theme

        html_theme = "sphinx_rtd_theme"
        html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
    except Exception:
        pass

我的index.rst

Welcome to exceptive's documentation!
=====================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   index
   annotation-module

Here I have some introductory text.

annotation-module.rst甚至不包含任何toctree,我下面只有几个部分。

那么,如何仅激活边栏上的当前文档部分?

HereSteve Piercy请求的文档的源目录。


环境

  • Python 3.5
  • Sphinx 1.7.6
  • sphinx-rtd-theme 0.4.0

2 个答案:

答案 0 :(得分:0)

所以,我有点解决了这个问题。问题出在某种程度上sphinx-autobuild上,我在问题中没有提到。

每次更新文档并与make html的{​​{1}}一起使用时,我只需使用node

还在http-server中引用index会产生警告:

index.rst

因此,从WARNING: self referenced toctree found. Ignored. 中删除index暂时解决了我的问题。

答案 1 :(得分:0)

我尝试用 index 替换 self

示例(index.rst):

Welcome to exceptive's documentation!
=====================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   self
   annotation-module

Here I have some introductory text.