如何创建一个不会出现在狮身人面像中的标题

我使用sphinx为python模块创建文档。

我希望在页面上添加字幕，但我不希望它们出现在toctree中 。

我想要小节和简短（几行）的描述。 将每个章节标题添加到toctree会使浏览文档变得更加困难。

这是我的index.rst ：

Welcome to ModernGL's documentation!
====================================

.. figure:: Examples/images/02_uniforms_and_attributes.png
    :scale: 50 %
    :alt: ModernGL
    :align: center
    :figclass: align-center

Start `here <ModernGL.html>`_.

.. toctree::
    :maxdepth: 4
    :caption: Contents:

    ModernGL <ModernGL.rst>
    Examples <Examples.rst>
    Contributing <Contributing.rst>


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

我想添加一些字幕：

Subtitle 1
**********

Subtitle 2
**********

Subtitle 3
**********

Subtitle 4
**********

我检查了文档，我不知道应该使用哪种类型的下划线。 不确定是否有特殊的下划线将标题转换为<h4>或<h5>

使用github README.md添加更多#字符将导致更小的标题。 * .rst中的等效项是什么？

构建文档可以在这里找到，它不包含字幕，因为它会破坏当前文档的结构。

---

您是否尝试在您的toctree指令中添加hidden toctree ？ 就像是：

.. toctree::
    :maxdepth: 4
    :hidden:
    :caption: Contents:

    ModernGL <ModernGL.rst>
    Examples <Examples.rst>
    Contributing <Contributing.rst>

这仍然会通知狮身人面像文档层次结构，但不会将链接插入到指令位置的文档中 - 如果您打算自己插入这些链接，或以不同的样式或HTML侧边栏，这是有意义的。

至于“章节标题”（标题和字幕），这个来自官方Sphinx文档的摘录可能会给你一个答案：

通常，由于结构是从连续的标题确定的，因此没有指定给某些字符的标题级别。

您可能会尝试使用^字符来表示您需要的标题。

链接地址: http://www.djcxy.com/p/84135.html

上一篇: How to create a title that will not appear in the toctree with Sphinx

下一篇: Can Sphinx Section Numbering Skip Certain Sections (like a title)?