Python sphinx 重组文本页面中的非TOC标题

我正在使用Sphinx编写一些文档

有没有一种方法可以在一个页面中设置标题的格式而不成为TOC的一部分？ 理想情况下，是否具有某种反映在格式中的层次结构

我想做什么

My page TOC heading
===================

Subheading (not in TOC, and should be formatted e.g. smaller than the heading)
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

Sub-subheading (not in TOC, and formatted e.g. smaller than the subheading)
###########################################################################

对于如何标记文本以使其具有更结构化的外观，读者也欢迎任何其他建议。

，StructuredText的参考实现，Sphinx的构建基础允许您将选项传递给，允许您控制目录进入文档层次结构的深度。从中，

contents

指令采用

depth

选项：

深度：整数

目录中收集的节级别数。 默认设置为无限深度

因此，要获得目录中只包含顶级标题的文档结构，可以使用

.. contents: Table of Contents
   :depth: 1

编辑：斯芬克斯似乎实现了自己的功能，因此您可以使用

.. toctree: Table of Contents
   :maxdepth: 1

---

而不是上面的第一个代码块。另外，请查看

隐藏

选项，这可能有助于进一步控制目录中包含的级别。

您可以为类似标题样式的量规创建自定义样式

（1） 在ReST源中，定义如下自定义样式：

.. role:: style1
    :class: class1

.. role:: style2
    :class: class2

这里“style_u2;”是ReST中引用这些的句柄，“class_2;”是CSS类名

（2） 将上述内容用作量规中的内联样式：

.. rubric:: :style1:`fake H1`

.. rubric:: :style2:`fake H2`

（3） 不管CSS文件有什么意义，都要为新类定义样式：

.rubric > .class1 {
    whatever
}

.rubric > .class2 {
    whatever
}

如果您愿意，这里的“whatever”可以与H1、H2等的现有样式相同

---

注意：在步骤（3）中，您可以更广泛或更狭义地定义CSS选择器。如果新类名是全局唯一的，那么选择器可以像

.class1

一样简单；或者，如果你想像我的例子那样只对顶级rubric使用样式，你可以使用

p.rubric>span.class1

。

对于我来说，我必须将

:maxdepth:1

和

:titlesonly:

添加到目录树部分。这是添加到“父”rst文件（或包含

.toctree:：

的任何文件）中的。目前，我正在使用深度设置，在当前的文档结构中，这不是一个问题。但是，每个分支具有不同深度的结构是不可能的。一个实际的示例是“简介”我可能想细分的部分，但这些部分的重要性肯定不同于“设备管理”部分。我想在TOC中细分后一部分，但不是前一部分。这应该标记为正确答案。感谢分享！