全部在RST文件中创建toctree

时间:2019-03-22 08:37:00

标签: python documentation python-sphinx

我有2个第一个文件:

folder:
 |_file1.rst
 |_file2.rst

file1.rst:

.. toctree::
   :maxdepth: 3


Name1
========

Name2
========

file2.rst:

.. toctree::
   :maxdepth: 3


Name3
=========

Name4
=========

如何在树中合并来自1和2个文件的标题。和导航在两个文件中相同

1 个答案:

答案 0 :(得分:0)

我对您的问题的理解是,您当前有两个文件带有自己的“本地”目录树(顺便说一句,不会做任何事情),并且希望第三个文档提供全局目录树。如果正确,那么您只需要创建该文件,为其提供一个toctree并指定要链接到的文档:

.. toctree::
   :maxdepth: 2

   file1
   file2

请注意,Sphinx关心的是标题的级别,而不是文档本身,因此,因为您的所有标题都是“顶级”的,因此您的全局toctree将是

  
      
  • Name1
  •   
  • Name2
  •   
  • Name3
  •   
  • Name4
  •   

不是,例如

  
      
  • 文件1      
        
    • Name1
    •   
    • Name2
    •   
  •   
  • 文件2      
        
    • Name3
    •   
    • Name4
    •   
  •   

我不知道要哪个,但是如果是后者,则需要在文档中添加一个顶级的“文档名称”标题(通常是带有上划线和下划线的标题,上划线的工作量并不大)因为它只是以这种方式标记的单个标题/行)。