问题标签 [toctree]

我是 Sphinx 的新手，我试图toctree在 Sphinx 中包含一个，但它似乎完全忽略了我的toctree选择。

我有如下所示的代码：

这也被忽略：

结果输出看起来像这样：

• 富
  • Foo1
    • Foo12
  • Foo2
• 酒吧
  • 酒吧1
    • 酒吧12
  • 酒吧2

我正在运行make html以生成 HTML 文档，我想我的 conf.py 文件中的设置可能有误。

genindexSphinx在构建文档时生成一个名为的索引，因此禁止使用该名称作为文档。现在，如何在目录中包含指向该索引的链接？

我试过这个：

虽然最后一行确实在文档中创建了指向该索引的链接，但构建在创建 TOC 时不知道引用：

文档说“通过将深度作为数字参数提供给 ”，“也可以编号到特定深度” numbered，这是一个toctree选项。但是给它0或1的深度是行不通的。还有其他想法吗？

我正在使用 Sphinx 来记录我的 Python 项目。我的问题是我在目录下的所有 python 文件，都在一页下列出。

这就是我到目前为止所拥有的。我会在不同的 html 页面中归档 Python_file_1、Python_file_2 和 Python_file_3。除了他们在同一页面下。任何建议或评论将不胜感激！

我们正在考虑在我工作的地方使用 Sphinx，它似乎可以满足我们的一切需求。但是，我在让它与所需的公司模板相匹配时遇到问题，这需要在标题页和目录之间插入一些前页。

如果 text is text 放置在 .rst 文件中的主目录之上，那么它会放置在 HTML 输出中的 TOC 之上，但它会移动到 pdf 输出中的 TOC 之下。我也试过添加一个隐藏的目录，但这也不起作用。内容也被放置在非隐藏目录之后。

我知道这必须是可能的，因为人们已经使用这个工具出版了书籍，但我不知道该怎么做。

我已经用 sphinx 1.4.0 和 1.4.1 试过了。这是我需要添加乳胶 sty 或 cls 文件才能使其工作的东西吗？我不想这样做，因为我们想同时使用 HTML 和 PDF 输出。

谢谢

我的 index.rst 中有一个目录树，看起来像这样：

我希望嵌套我的 toctree 的内容，类似于使用“api 文档”在此处完成的方式：

所以最终做出这样的事情：

但我似乎在文档中找不到任何这样做的东西。

我正在使用带有 numpydoc 扩展和自动摘要的 sphinx。经过一些实验，我在我的 conf.py 文件中添加了以下选项。

这为我下面引用的每个类提供了一个新文件，它还创建了所有属性和方法的汇总表。

问题是，虽然在文档字符串的第一行有一个方法的汇总表，但方法的名称并没有链接到任何东西。如何获取方法的文档字符串以创建自己的文件（或至少在与类相同的文件中生成文档）？

toctree在 Sphinx 中的常用用法如下所示：

例如，如果foo.rst标题以“Being Foo”bar.rst开头，以“Doing Bar”开头，并baz.rst以“Thinking Baz”开头，那么您将得到一个看起来像这样的漂亮目录：

• 成为 Foo
• 做酒吧
• 思考巴兹

带有从每个链接到相应页面的链接。

我的问题：有没有办法注释一个目录树？例如，如果我想用“W. Robert Foo 在 1857 年创建了第一个元句法变量，我们一直在使用它”之类的东西来注释“Being Foo”标题，那么我可以把那个文本放在某个地方（希望在 的顶部foo.rst，但如果不是，则在 toctree 指令中），并且 toctree 输出将如下所示：

• 成为 Foo — W. Robert Foo 在 1857 年创建了第一个元句法变量，从那时起我们就一直在使用它。
• 做酒吧
• 思考巴兹

我要记录的项目结构如下：

我想引用toctree子目录（a 和 b）中的 s，以便项目toctree可以看到项目树中的 4 个文档。

我知道当文档位于一个目录中时如何执行此操作，但如果我将它们放在子目录中，我不知道如何执行此操作。我试图保持我的项目结构完整，而不必将所有文件移动到一个目录中。我做了一些研究，发现这 .. include:: directive可能是要走的路，但我不知道如何正确使用它。

假设我有以下内容index.rst：

并且nested/index.rst：

我希望 TOC 像：

• 一些全球性话题
  • 全球话题介绍
  • 一些子主题

相反，我得到以下信息：

• 一些全球性话题
  • 一些子主题
  • 全球话题介绍

如何使本地部分首先出现，然后链接页面？