如何保留Sphinx中的部分/章节结构而不创建单个长页面?
问题描述:
我已经了解到,可以通过多个文件by using the include
command将部分/章节等文档保存为模块形式。如何保留Sphinx中的部分/章节结构而不创建单个长页面?
这种方法唯一的问题是,它有效地将所有包含的文件连接成一个大文件,这意味着它们不再被Sphinx Read The Docs theme视为单独的页面。
由于这一结果,文档有用户需要向下滚动,而不是previous
/next
按钮导航短的网页很长页面。我希望我的文档具有后一种结构,因为我认为它创建了更舒适的用户体验。
如何在不创建单个长页的情况下保留部分/章节结构?
答
立足自己在前面的问题,你参考,我应该提醒你注意的是给予有以上的解决方案,以便对问题本身:-)
你的文件没有正确地再现标题(“部分“反对”章节),因为toctree指令认为被包含文档中的第一个标题是该文档的“首要标题”。另一种解决方案是在主文件中使用toctree指令移动
######
Part 1
######
部分。
######
Part 1
######
.. toctree::
:maxdepth: 2
test1
test2
我通过经验了解到了这一点。不过,我找不到合适的参考。
这就是'toctree'的用途。 http://www.sphinx-doc.org/en/stable/markup/toctree.html – mzjn
嗨@mzjn,谢谢你的评论。我已经阅读了关于'toctree'的文档,并且知道如何使用它,但我不确定当你说'这就是'toctree'是'的时候我知道你的意思。你能否在完整答案中详细说明你的评论? – AZD
我不明白问题所在。 toctree可以用来“保留部分/章节结构而不创建一个单独的,长的页面”。 – mzjn