不同的:maxdepth:用于toctree(Sphinx)中的特定条目

时间:2019-05-18 03:32:42

标签: python python-sphinx

我为我建立的库提供了一些基于Sphinx的文档,并且我想显示除变更日志以外的所有页面的扩展目录。我想出了如何通过将更改日志移至第二个:toctree::来完成此操作的方法,但这有一些奇怪的行为。主要是,当我访问页面时,更改日志显示在不同的项目符号列表上,并且当我使用侧栏导航时,我只能在每个toctree中进行导航(如果单击更改日志,则不会在侧栏上显示其他部分)。有更好的方法吗?

这就是我现在拥有的:

.. toctree::
   :maxdepth: 5

   getting_started
   examples
   modules

.. toctree::
   :maxdepth: 1

   changelog


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

1 个答案:

答案 0 :(得分:0)

使用Read the Docs模板,您可以实现此目标。您还必须操作 _static 目录中的 style.css 文件。只需添加

.rst-content .toctree-wrapper:not(:last-child) ul {
   margin-bottom: 0;
}

,两棵单独的toc树看起来就像一棵,将显示在侧栏中。

对于其他Sphinx模板,对渲染的html进行检查可以使您朝正确的方向寻找正确的CSS选择器。但是我不知道这些模板如何处理边栏。