问题标签 [toctree]

我需要以toctree正确的顺序在我的 sphinx 文档中包含页面内容和一些外部链接

假设这是我的结构：

然后得到的目录树是

• 测试
• 第1页
• 第2页

但我需要它

• 第1页
• 第2页
• 测试

所以，我需要一种方法来更改目录树的顺序，或者手动将包含的页面添加到目录树中，这也很好。

我目前想出的唯一“解决方案”是包含虚拟文档。但这会导致用户的导航路径不太好。

注意：此问题部分与此https://stackoverflow.com/questions/35659349/sphinx-place-minor-pages-in-the-right-place-in-the-toc/35672388#35672388有关

我可以通过两种方式创建目录：

或作为

有什么区别？我应该在哪里使用目录树和内容？

我有一个使用 Read-The-Docs 主题以编程方式生成的 sphinx-doc 源。源代码树如下所示：

index.rst包括一个目录，如：

并model_search.rst包括所有模型index.rst：

当我最初使用 构建源代码时make html，它构建得很好，并创建了一个包含所有现有模型的 TOC。

但是，当我添加一个新模型（例如3lin）make build时，TOC 不会在现有模型（ 、 等）的页面上重新1lin生成2lin。我发现在所有页面上正确重新创建目录的唯一方法是修改conf.py（例如启用/禁用autodoc）或手动touch所有相关.rst文件。

TOC 是否应该在旧模型页面上重新生成，或者这是预期的行为？如果它应该发生，出了什么问题？

我正在使用他们的主题在 ReadTheDocs 上使用 Sphinx 创建我的文档。构建过程会生成一个 genindex.html 文件，可以通过以下方式引用：

创建：

链接到索引页面。

我无法添加genindex到我的目录树中，例如：

因为它是一个自动生成的文件，在渲染时不存在。此外，Sphinx 期望 genindex 是一个名为genindex.rst.

如何将其添加到我的 ToC / 导航？

我有一个 sphinx 文档项目，用于生成文档的 HTML ( make html) 和 PDF ( make latexpdf) 版本。我使用子目录来组织一些页面。我的目录结构是这样的：

我在两个 index.rst 文件中都指定了一个目录树：

当我生成 HTML 时，该subsection1/index页面具有目录列表，其中包含指向相应页面的链接。当我生成乳胶 PDF 时，它会忽略子目录树并且不打印任何内容，但我希望它与 HTML 相同。

我对乳胶没有很多经验，而且我在网上找不到任何关于这个的东西，所以我觉得我错过了一些明显的东西。我已经研究过了.. contents::，.. include::但当然这并不能产生我想要的 HTML，我希望我不必有很多.. only::零件。

我正在 Sphinx 中制作一系列设计文档，我想将它们一起包含在 atoctree中，并对文档中的部分进行编号。我知道我可以用来.. sectnum::对子页面中的所有部分进行编号。然而，Sphinx/rst 为页面标题编号（实际上只是第一部分），目录最终看起来像：

每个子页面看起来像：

我想要的是我的索引页上的一个目录，它只列出了标题

和看起来像的子页面

有没有办法让标题显示在目录中以及最终不是编号部分的子页面顶部？

我正在使用 Sphinx 为 Python 模块创建文档。

我想在页面上添加字幕，但我不希望它们出现在toctree中。

我想要小部分和简短（几行）的描述。将每个部分的标题添加到目录树会使浏览文档变得更加困难。

这是我的index.rst：

我想添加一些字幕：

我检查了文档，但不知道应该使用哪种类型的下划线。不确定是否有特殊的下划线将标题转换为<h4>或<h5>

使用 github README.md添加更多#字符将导致更小的标题。*.rst中的等价物是什么？

构建文档可以在这里找到，它不包含字幕，因为它会破坏文档的当前结构。

几天前我开始使用 Sphinx 来记录一个 python 包，我得到了一个似乎很常见的错误，但我找不到解决方案。

我使用 sphinx-quickstart 来设置所有内容。我使用“doc/”作为文档根位置。包含我的包的文件夹设置为：

快速启动后，我将 conf.py 中的路径编辑为：

然后我将包中的一个脚本添加到 index.rst 以查看 sphinx 的工作原理。

我得到的错误代码：

我尝试过的解决方案：

1. 将 sphinx.ext.napoleon 添加到扩展列表中，因为我所有的文档字符串都是使用 numpy 格式编写的。错误并没有消失。我还将拿破仑扩展名放在 autodoc 之后，因为其中一个帮助页面建议这样做。

   扩展 = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon']

2. 将 numpydoc_show_class_members = False 添加到 conf.py。我把它直接放在扩展下面。这也没有帮助。

3. 文件夹位置的几种不同配置。我还尝试将根位置设置为 myfolder 并将源设置为 mypackage 并将构建设置为 doc。没有一个有效。

你有什么想法可以帮助我吗？

我是使用Sphinx的新手。只要我的文件位于source顶层文件夹中，我就可以创建 HTML 文档。

一旦我将它们放在 .Sphinx 中的子文件夹中source directory，Sphinx就不会将文档包含在构建中。Sphinx在生成测试文档后告诉我不包括在内。因此，它会看到文件但不包含它。

我错过了什么吗？我是否必须在index.rst文件或? 中指定任何子文件夹config.py？

我的index.rst文件：

我的config.py文件：

编辑：this other post似乎相关

我正在使用fulltoc扩展在侧边栏中显示目录。

全局目录在全局 index.rst 文件中定义。toctree它实际上基本上是由一系列s组成的：

包含每个部分的overview.rst描述和随后部分的目录树。在文件夹中，gettingStarted此文件如下所示：

问题是，在查看页面时gettingStarted/overview，侧边栏会显示 sub-toc，这会产生多余的条目：

入门

• 概述
  • 第 1 节
  • 第2节
• 第 1 节
• 第2节

我宁愿在哪里

入门

• 概述
• 第 1 节
• 第2节

一种解决方法是降低:maxdepth:，但是当从一个部分（例如gettingStarted/section1）读取时，侧边栏不会展开子部分。

我还找到了该rubric指令，但无法弄清楚如何使其在toctree.

如何防止子目录被索引到全局目录中？