python - 全部在 rst 文件中创建目录树

Question

我有 2 个文件：

folder:
 |_file1.rst
 |_file2.rst

文件 1.rst：

.. toctree::
   :maxdepth: 3


Name1
========

Name2
========

文件 2.rst：

.. toctree::
   :maxdepth: 3


Name3
=========

Name4
=========

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

标签： pythonpython-sphinxtoctree

Answer 1

我对您的问题的理解是，您目前有两个文件，它们都有自己的“本地”目录树（不附带任何操作），并且想要第三个文档提供全局目录树。如果这是正确的，那么您只需要创建该文件，给它一个目录树并指定要链接到哪些文档：

.. toctree::
   :maxdepth: 2

   file1
   file2

请注意，Sphinx 关心标题的级别，而不是文档本身，所以因为您的所有标题都是“顶级”，所以您的全局目录树将是

• 名称1
• 名称2
• 名称3
• 名称4

不是例如

• 文件 1
  • 名称1
  • 名称2
• 文件2
  • 名称3
  • 名称4

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