狮身人面像(RTD主题)部分导航不一致

时间:2019-04-22 04:33:46

标签: python-sphinx read-the-docs

我的问题很难用言语传达。我会尽力的。

使用Sphinx 2.0.0,我有一个带有以下“根”目录树的项目。这是索引toctree:

Welcome to FIRST Robotics Documentation
========================================================

.. toctree::
   :maxdepth: 2
   :caption: WPILib Software

   software

.. toctree::
   :maxdepth: 2
   :caption: WPILib Hardware

   hardware

.. toctree::
   :maxdepth: 2
   :caption: Robot Networking

   networking

这很好。

我现在有一个看起来像这样的结构:

What the Toctree Looks Like

现在让我们使用"software" toctree索引页面

.. toctree:: 
   :maxdepth: 1

   quick urls here

Getting Started
===============

.. toctree::
   :maxdepth: 1

   docs here

WPILib Overview
===============

.. toctree::
   :maxdepth: 1

   docs here

这给了我一个看起来像这样的页面:

screenshot 2

但是,问题是当您开始导航到子子目录树时。当您进入“ WPILib概述”部分时,顶部导航栏显示为“入门”,这在其他部分中也可以重现。

Example of an article listed under the wrong section

在上图中,它应该显示“ WPILib概述”而不是“入门”。不幸的是,没有。

源代码可在以下位置公开获得:https://github.com/daltz333/frc-docs 网页来源和问题网址:https://frc-docs.rtfd.io/en/develop

除了将每个部分分成自己的文件之外,我想不出任何解决方案,这不是不是选项。

1 个答案:

答案 0 :(得分:0)

您需要在navigation_depth中将html_theme_options设置为conf.py的属性,即:

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
html_theme_options = {
    'navigation_depth': 2
}

有关更多信息,请参见their documentation有关主题选项的配置。