如何在Sphinx toctree中添加标题而不添加新文档?

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

[好,我正在使用Sphinx Autosummary生成某些类的文档。有三种不同类型的类,我希望我的侧边栏具有三个不同的部分,例如如果我在toctree指令中使用:caption:选项。

所以我添加了将我的autosummary指令分成三个较小的指令,并在它们之间放置了一个隐藏的toctree,如下所示:


Section 1

.. toctree::
   :hidden:
   :caption: Section 1

.. autosummary
   :toctree: stubs

   myclass
   anotherclass


Section 2

.. toctree::
   :hidden:
   :caption: Section 2

.. autosummary::
   :toctree:

   thirdclass

产生类似的边栏:

myclass
anotherclass
thirdclass

这不起作用。 index.html的层次结构正是我想要的样子,但是侧边栏缺少我的标题,它们没有显示。当我在任何这些隐藏的toctree下添加self之类的页面时,标题就会显示:


Section 1

.. toctree::
   :hidden:
   :caption: Section 1

   self

.. autosummary
   :toctree: stubs

   myclass
   anotherclass


Section 2

.. toctree::
   :hidden:
   :caption: Section 2

.. autosummary::
   :toctree:

   thirdclass

产生类似的边栏:

SECTION 1 (caption)
Documentation Home
myclass
anotherclass
thirdclass

这是我一直在寻找的东西,但是我不想引用self或其他任何东西。我只想要字幕。我该怎么做?

python python-sphinx restructuredtext
1个回答
0
投票

autosummary指令放在单独的文件中,并将每个文件添加为toctree条目。这应使用sphinx_rtd_theme生成所需的侧边栏。

.. toctree::
   :caption: Section 1

   autosummary1

.. toctree::
   :caption: Section 2

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