问题标签 [toctree]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
2 回答
9447 浏览

python-sphinx - 超过 3 级标题的 Sphinx 部分编号:.. sectnum::

我正在使用 Sphinx 从 rst 文件生成 pdf 文件。Sphinx 自动生成高达 3 级标题的章节编号,以及高达该级别的目录。但是,我希望所有级别的标题都被编号并在目录中。为了做到这一点,我正在尝试使用.. sectnum::http://docutils.sourceforge.net/docs/ref/rst/directives.html#table-of-contents)。结果并不完全符合我的预期:

  1. 在目录和正文的所有节号前面都加了一个数字 1.,也就是说,不是 1,而是 1.1,而不是 2,而是 1.2。

  2. 在 TOC 和直到第三级标题的文本中,节号都会重复,即在错误的前面有一个节号(正确的)(前面添加了 1.)。

这是我的示例 rst 文件:



这是 TOC 的结果:

(我拍摄了我的 pdf 文件以显示结果,但我刚刚发现我无法发布图片,因为我需要 10 名声望,这是我第一次发布任何东西)

这是文本的结果:

如您所见,在节号中添加了 1.,并且在第 3 级之前的标题中有重复的部分。

0 投票
1 回答
2659 浏览

latex - 如何设置 Sphinx 和 latexpdf toc 深度?

我有一个用“sphinx-quickstart”创建的香草狮身人面像项目(Sphinx 1.2b3。)

我添加了一个带有 4 个标题级别的基本 page.rst。

我可以在 index.rst 中控制 html toc 的深度:

根据文档http://sphinx-doc.org/latest/markup/toctree.html我调整 conf.py 如下:

然后我建立:

html 仅按预期显示 1 级,但 pdf 继续显示 2 个 toc 级别 - 屏幕截图在此处输入图像描述

有什么提示吗?

谢谢

佩尔

解决方案

由 jacob 提供 -> 简单地认为所需的级别 num -1:

0 投票
1 回答
1991 浏览

python-sphinx - 从 toctree 隐藏特定文件?

我在本地主机上使用readthedocs.org实例从我的github存储库构建 HTML 文档,我希望能够执行以下操作。

目前,我有一个使用 toctree 的 glob 功能读取的文件列表,如下所示:

但我需要避免在我的目录中列出某些文件,例如:

我尝试:hidden:在该部分下方添加一个,:glob:但它只是隐藏了所有内容。

我已经查看了我能找到的尽可能多的文档,但是当这两个选项一起使用时,我没有找到一个例子。

知道如何实现这一目标吗?

0 投票
2 回答
1618 浏览

python-sphinx - 在目录树中添加 self 的子部分

我在获取目录 (TOC) 以显示我的文档首页的小节时遇到问题。

我的首页上有许多部分,我希望这些部分显示在目录中。小节的显示适用于目录中包含的所有其他页面,但不是 self.

我的index.rst代码:

我希望在 TOC 中看到的是:

  • 标题
    • 小节
    • 内容
  • 发展
    • 小节

相反,我得到的是:

  • 标题
  • 发展
    • 小节

到目前为止,我找到了一种解决方案,但它并不令人满意。我可以将所有内容放在单独的页面中,然后将内容包含在index.rstusing.. include:指令中,并将单独的页面放在 TOC 中。这使 TOC 看起来正确,但会创建一个重复的页面,该页面现在包含在导航中(上一页/下一页)。

0 投票
1 回答
2554 浏览

python - 如何有条件地将文件包含在 Sphinx 'toctree' 中?

我只想在设置了某个标签时才将我的一个文件包含在我的 Sphinx TOC 中,但是明显的方法失败了:

有没有一种简单的方法可以做到这一点?

0 投票
1 回答
1575 浏览

python-sphinx - 将 Sphinx TOC 划分为带有子标题的小节

我有一个 Sphinx 主文档,其中包括如下子文档:

我想将 TOC 划分为部分或小节,以便它按照以下方式呈现:

我目前的方法是创建伪子文档,列出其 TOC 中的实际文档,例如,“part1.rst”将具有:

然后在主文档中:

这样做的问题是,当单击“part1”的链接时,您会被带到一个没有实际内容的页面(“part1.rst”)。

还有其他方法吗?

或者,有没有办法禁止“part1.rst”的条目生成页面链接?

0 投票
1 回答
164 浏览

include - 不同文件的标题不匹配

我在 Sphinx 中有一个非常基本的设置。目录如下:

文件一和二如下所示:

第一个

二.第一:

两个文件具有相同的格式,我想最终得到以下结构

然而,斯芬克斯给了我

我拆分文件的原因是它们相当大,我想保持它们很小,以便我可以轻松地编辑它们。如何在不同的文件中获得相同的标题样式(具有相同的上划线/下划线字符)?

0 投票
0 回答
58 浏览

python-sphinx - 指向非 reST 文件的目录树条目

我已经用 javadoc 构建了一些 HTML 文件。我在 Sphinx_static目录中有那些。现在我正在尝试在 Sphinx 中添加指向这些 HTML 文件的链接toctree

有没有办法做到这一点?尽管我试过 Sphinx 只接受 .reST 文件toctree

0 投票
2 回答
4613 浏览

python-sphinx - 使用 Read the Docs 主题时如何将 Sphinx 生成的索引添加到侧边栏?

我想在使用sphinx-rtd-theme. 我试过将它添加到目录树中:

但这导致

从狮身人面像,没有其他效果。

我想我可以简单地对主题文件中的索引进行硬编码layout.html,但也许有更好的方法,不涉及修改标准主题?

TIA 的任何提示!

0 投票
3 回答
2578 浏览

python - 使用 toctree 时防止 Python Sphinx 中的子部分嵌套

我在构建 Sphinx 用户指南时遇到了问题。我想通过一个包含章节标题和概述的主登录页面 (index.rst) 来形成一个章节,然后将包含在不同文件中的子部分分开 (part1.rst, part2.rst)。我正在尝试使用“toctree”来插入单独的小节,但是我遇到了嵌套问题,我的 toctree 被吸入了我的概述部分。(注意:我没有使用该..include::指令,因为我希望在不同网页上显示的子部分按顺序链接。我还希望结构正确,以便它们在 UG 的 pdf 呈现版本中很好地布局)。

索引.rst

第 1 部分.rst

第 2 部分.rst

我希望得到的结构是:

但我得到的是

我在文件底部包含的目录树似乎属于“概述”部分,而不是在主要章节上下文中运行。我尝试在文件顶部插入目录树,但后来我得到了这个顺序:

似乎必须有一种方法可以正确地做到这一点,但我无法在 Sphinx 网站或 SO 上找到任何东西。任何帮助表示赞赏。