Sphinx toctree最大深度,用于显示,但不用于导航侧栏

问题描述 投票:0回答:1

我想在根索引中使用类似这样的内容:

.. toctree::
   :maxdepth: 1

   sub1/index
   sub2/index

因此仅显示顶级标题。

但是这也限制了导航侧栏。是否可以避免这种情况?


我发现reading toctree documentation有一个丑陋的解决方法:添加第二个隐藏的无限toctree:

.. toctree::
   :hidden:

   sub1/index
   sub2/index

.. toctree::
   :maxdepth: 1

   sub1/index
   sub2/index

但是这很令人讨厌,因为现在必须在每个子主题中重复列出子主题。

编辑:实际上此解决方法不起作用:隐藏的ToC在导航侧边栏中完全可见。

python-sphinx restructuredtext
1个回答
0
投票

也许您正在寻找titlesonlytoctree选项:

.. toctree::
    :titlesonly:

    sub1/index
    sub2/index

https://www.sphinx-doc.org/en/2.0/usage/restructuredtext/directives.html#directive-toctree

© www.soinside.com 2019 - 2024. All rights reserved.