所有都在rst文件中创建toctree

问题描述 投票:0回答:1

我有第2个文件:

folder:
 |_file1.rst
 |_file2.rst

file1.rst:

.. toctree::
   :maxdepth: 3


Name1
========

Name2
========

file2.rst:

.. toctree::
   :maxdepth: 3


Name3
=========

Name4
=========

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

python documentation python-sphinx
1个回答
0
投票

我对你的问题的理解是你目前有两个文件有他们自己的“本地”toctrees(它没有偶然做任何事情)并且想要第三个提供全局toctree的文件。如果这是正确的,那么您只需要创建该文件,给它一个toctree并指定要链接到的文档:

.. toctree::
   :maxdepth: 2

   file1
   file2

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

  • 名1
  • 名称2
  • 那抹
  • NAME4

不是例如

  • 文件1 名1 名称2
  • 文件2 NAME3 NAME4

我不知道你想要哪一个,但如果是后者,你需要在你的文档中添加一个顶级的“文档名称”标题(通常标题都是标题和下划线,因为它仅限于标题,因为它只是单个标题/行标记的方式)。

© www.soinside.com 2019 - 2024. All rights reserved.