Sphinx index.rst

  • Post author:
  • Post category:其他


假设我们有两个文本file1.rst和file2.rst他们的内容如下

file1.rst

file1 title1
============
这里是段落内容

file1 title1.1
--------------
这里是内容

file1 title1.2
--------------
这里是内容

file2.rst

file2 title1
=============
这里是段落内容

file2 title1.1
--------------
这里是内容

file2 title1.1
--------------
这里是内容

下面是index.rst内容

.. toctree::
   :maxdepth: 2 # 2表示在索引中添加各个文件的2级标题
   :numbered: # 如果有多个章节则可以进行编号

   intro # 添加文件,不需要写后缀

:maxdepth: 1

这里写图片描述

:maxdepth: 2

这里写图片描述

:numbered:

这里写图片描述

参考文献:


http://zh-sphinx-doc.readthedocs.io/en/latest/markup/toctree.html



版权声明:本文为claroja原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。