首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >所有在rst文件中创建toctree

所有在rst文件中创建toctree
EN

Stack Overflow用户
提问于 2019-03-22 16:37:00
回答 1查看 351关注 0票数 0

我有两个第一个文件:

代码语言:javascript
复制
folder:
 |_file1.rst
 |_file2.rst

file1.rst:

代码语言:javascript
复制
.. toctree::
   :maxdepth: 3


Name1
========

Name2
========

file2.rst:

代码语言:javascript
复制
.. toctree::
   :maxdepth: 3


Name3
=========

Name4
=========

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

EN

回答 1

Stack Overflow用户

发布于 2019-03-22 16:55:56

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

代码语言:javascript
复制
.. toctree::
   :maxdepth: 2

   file1
   file2

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

  • Name1
  • Name2
  • Name3
  • Name4

不是,例如

  • Name1
  • Name2

  • file1

  • Name3
  • Name4

  • file2

我不知道你想要哪一个,但如果是后者,你需要给你的文档添加一个顶层的“文档名称”标题(通常是一个加下划线和加下划线的标题,加下划线的工作量并不大,因为它只是一个标题/行,用这种方式标记)。

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/55295703

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档