13

是否可以从主 TOCTree 隐藏 RST 文件中存在的一个（或所有）小节？

让我再描述一下：

索引.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>

孩子/file.rst

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

.. toctree::

   Label of Grandchildren 1
   Label of Grandchildren 2


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

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

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

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

  • 标签
  • 标签
  • 儿童标签
    • 孙子的标签 1
    • 孙子的标签 2
    • 第 1 款
    • 第 2 小节
    • 第 3 小节

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

  • 标签
  • 标签
  • 儿童标签
    • 孙子的标签 1
    • 孙子的标签 2

但是，如果单击与儿童标签关联的超链接，则子部分将照常列出；

4

5 回答 5

11

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

对我来说，我先在父级的 toc 中添加了:maxdepth:1and ，然后在子级的 toc 中添加了和，这非常有效。这使我可以在子项中进行分层子节格式，该子项可以正确呈现，但不会显示在 TOC 中。:titlesonly::titlesonly:

于 2016-11-04T15:27:45.093 回答
7

“rubric”指令可以实现你想要的：

http://sphinx-doc.org/markup/para.html#directive-rubric

它不会以完全相同的方式生成章节标题，但至少它们不会出现在目录中

于 2013-08-17T00:11:10.133 回答
4

您可以使用 的maxdepth参数toctree来设置 TOC 的深度：

.. toctree::
    :maxdepth: 2
于 2013-08-31T18:28:05.930 回答
2

尝试将第 1 小节的 ------------------ 更改为 ***************** 等。此外，您可以制作多个目录树每个都有自己的最大深度，例如

.. toctree::
    :maxdepth: 2

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

.. toctree::
    :maxdepth: 1
    Label of Children TOCTree <path/to/rst/children/file>
于 2018-01-24T05:30:28.767 回答
0

您可以制作自己的标签

你想要你的标题类型的地方

|start-h3| My Title |end-h3|

在文件写入结束时

.. |start-h3| raw:: html

     <h3>

.. |end-h3| raw:: html

     </h3>
于 2021-02-27T00:45:53.637 回答