python-sphinx - 从主 TOCTree 中隐藏 Sphinx 子部分

Question

是否可以从主 TOCTree 中隐藏 RST 文件中存在的一个(或所有)子节？

让我再描述一下:

index.rst

:doc:`Label <path/to/rst/file>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. toctree::

   Label <path/to/rst/file>
   Label <path/to/rst/file>

   Label of Children TOCTree <path/to/rst/children/file>

child /file.rst

Children Title
==============

.. toctree::

   Label of Grandchildren 1
   Label of Grandchildren 2


Subsection 1
------------

Subsection 2
------------

Subsection 3
------------

这些文件在构建后将生成在主 TOCTree 中:

标签

标签

child 标签

孙子标签 1

孙子标签 2

第1款

第2款

第3款

我想隐藏子部分，只保留 TOCTrees，尽可能多和尽可能深。例如:

标签

标签

child 标签

孙子标签 1

孙子标签 2

但是，如果超链接关联到 child 标签点击后，小节照常列出；

Answer 1

这花了我一段时间才弄明白，但我想我终于明白了。 “技巧”是您需要在包含 toc 的父 rst 和包含该部分的子 rst 中设置指令。

对我来说，我添加了 :maxdepth:1和 :titlesonly:到父目录中的目录，然后 :titlesonly:到 child 的toc，这完美地工作。这使我可以在子项中设置分层小节格式，该格式正确呈现而不会出现在 TOC 中。