Python 如何在Sphinx目录树中添加标题而不添加新文档?

Python 如何在Sphinx目录树中添加标题而不添加新文档?,python,python-sphinx,restructuredtext,toctree,Python,Python Sphinx,Restructuredtext,Toctree,好的,我正在使用Sphinx Autosummary为一些类生成文档。有三种不同类型的类,我希望侧边栏有三个不同的部分,就像我在toctree指令中使用:caption:选项一样 所以我添加了将我的autosummary指令分离为三个较小的指令,并在它们之间放置了一个隐藏的目录树,如下所示: Section 1 .. toctree:: :hidden: :caption: Section 1 .. autosummary :toctree: stubs mycl

好的,我正在使用Sphinx Autosummary为一些类生成文档。有三种不同类型的类,我希望侧边栏有三个不同的部分,就像我在toctree指令中使用:caption:选项一样

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


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
SECTION 1 (caption)
Documentation Home
myclass
anotherclass
thirdclass
这不管用。我的index.html的层次结构正是我想要它的样子,但是侧边栏缺少我的标题,它们没有显示出来。当我在这些隐藏目录树下添加一个类似于
self
的页面时,标题会显示:


Section 1

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

   self

.. autosummary
   :toctree: stubs

   myclass
   anotherclass


Section 2

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

.. autosummary::
   :toctree:

   thirdclass
生成一个边栏,如:

myclass
anotherclass
thirdclass
SECTION 1 (caption)
Documentation Home
myclass
anotherclass
thirdclass

这是我一直在寻找的,但我不想引用
self
或任何东西。我只想要字幕。如何做到这一点?

目录树的目的是组织嵌套页面,它至少应该有一个条目(文件名)。否则,使用它就没有任何意义了

下面的标记生成了想要的带有sphinx_rtd_主题的侧栏。我意识到它并没有给你你想要的索引页,但是我想不出任何其他的方法。将
autosummary
指令放在单独的文件中,并将每个文件添加为
目录树
条目

.. toctree::
   :caption: Section 1

   autosummary1

.. toctree::
   :caption: Section 2

   autosummary2

您是否使用sphinx_rtd_主题?是的,我正在使用该主题。此解决方案对我的index.rst有何影响?我假设用户不能像我喜欢的那样在一个页面上看到所有的类。实际上,它确实是。。。“不添加新文件”是问题标题的一部分。谢谢你的帮助。我希望侧边栏结构能反映我的主页结构。我不想要嵌套的页面。如果这在Sphinx rtd中是不可能的,不管怎样。我所要求的只是一种方法,使边栏结构与我的主页结构相匹配。在一个目录树中包含多个标题似乎并不疯狂。我只把零条目的目录树放在标题中,而不重新构建我的整个主页——这是问题的关键。如果斯芬克斯不支持这个选项,那么你可以这么说。不需要你评论的语气。