在toctree中添加自由文本注释

时间:2018-03-12 16:48:12

标签: python-sphinx

我想将分组添加到toctree中包含的模块/其他.rst文件中,以便更好地解释文档。

例如,下面列出的文件分为3个部分:

Contents:

.. toctree::
   **Part A - overview material**

   installation
   overview

   **Part B - Component design**
   module1
   module2

**Part C - Systems of components**
   module3
   module4
   module5

理想情况下,这将被渲染,以便“Part X”标签散布模块子弹点。

我在toc docs中找不到任何内容,但也许我错过了添加注释或错过关键字的内容? (注意:这个想法与LaTeX对齐方程中的\intertext{}非常相似)

当我尝试使用上面的示例时,如果标签是缩进的(按照A / B ),那么我会收到警告

WARNING: toctree contains reference to nonexisting document u'**Part A - overview material**'

或者如果标签没有缩进(按照C ),则toctree结束,并且第一个标签之后的所有文件(此处为module3,4,5)不被视为toctree的一部分(因此显示为纯文本,而不是链接)

有没有办法在狮身人面像的toctree中提供额外的材料?

0 个答案:

没有答案
相关问题