如何解决使用singlehtml构建选项时如何包含表fo的内容?
上下文
我正在使用Sphinx创建技术文档(与代码无关)。输入是几个reStructuredText和SVG文件。使用singlehtml
构建器创建输出(在以后的步骤中使用weasyprint将其转换为PDF)。
问题
我想在最终文件中包含目录(TOC)。 TOC(边栏)的默认位置不是一个选项。我必须禁用/隐藏侧边栏才能生成有用的PDF。
解决方案(我已经考虑过/尝试过)
-
toctree
directive:无论我如何尝试,似乎只能使用侧边栏。 - HTML Theming:我正在使用它来设置HTML输出的样式,但是我不知道如何解决TOC问题。
- Sphinx extensions:我写了我自己的书,但是它不是很灵活,我仍然相信其他人已经解决了这个问题。
- 使用
latexpdf
构建器:尝试过并解决了TOC问题,但是它还会产生其他一些问题,因此使用CSS对我来说,对文档进行样式设置要容易得多。 - Sphinx以外的其他工具:这是XY问题的典型案例吗?我想使用reStructuredText和SVG生成PDF,但是我愿意使用Sphinx以外的其他东西。
解决方法
,这是最简单形式的指令:
.. contents::
取决于语言的样板文字将用作标题。英文的默认标题文本为“目录”。
可以指定一个明确的标题:
.. contents:: Table of Contents
@mzjn已经怀疑,.. contents::
仅列出当前文件的内容,但是,如果我使用.. include::
而不是.. toctree::
来包含其他文档,它仍然有效。所以我目前正在使用的是这个:
.. sectnum::
.. contents:: Table of Contents
:depth: 2
.. include:: intro.rst
.. include:: processes.rst
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。