我收到警告：

对于文档中存在的文件，因为它们已被明确包含。所以我有索引文件：

在文件 0020-bar.rst 中，我特别包括了许多其他文件，如：

但是当我构建项目时，我仍然收到一个警告，即 0070-baz.rst 不在任何目录树中，如下所示：

奇怪的是我可以看到输出中的内容。这是正常的吗？对于明确包含而不是通过 toctree 包含的文件，是否总是出现此警告？

假设我有一个 Sphinx 项目，其来源如下：

index.rst（主页）具有以下目录树：

我希望我的模板包含一个侧边栏，列出所有 3 个顶级页面（主页、安装、模板/索引）。

我尝试在主页中添加第二个隐藏的 TOC 树：

这实际上给了我想要的结果，除了它将next变量设置为当前页面。所以我的模板中的这段代码：

…总是从主页输出主页链接。不好。

我一直试图将实际的主页链接硬编码到模板的侧边栏中：

这也有效，除了我不想强制在 web 服务器的 webroot 上访问文档——我希望它们也可以从文件系统中工作。

我不能简单地将 URL 设置为“index.html”，因为当您在模板/中的文件中时，这将不起作用。

我错过了一些明显的东西吗？必须有一种方法可以将主页放入 TOC，而不会破坏next链接，并且具有适用于本地文件系统的动态路径，即使是在子文件夹中也是如此。

我正在更新一个相当大的项目的常见问题解答，我想在页面顶部添加问题索引，以便用户更容易找到他们正在寻找的内容。

Sphinx 文档toctree 文章指出“特殊条目名称 self 代表包含 toctree 指令的文档。如果您想从 toctree 生成“站点地图”，这很有用。” 这就是我要的。问题是 self 似乎坏了，只包括当前文档的标题而不是字幕。当我在另一个文档中并引用常见问题解答时，它可以正常工作，只有在文档本身中它才会失败。

展示

在其他文件中导致

• 经常问的问题
  • 常问问题
    • 问题 1
    • 问题2
    • 问题 3
  • 不明显的行为和其他需要知道的

内部常见问题

结果是

• 经常问的问题

我认为这可能是因为 sphinx 在转换目录树并尝试将目录树移动到页面底部时不知道字幕。没变。

任何关于如何使用 sphinx 在页面本身中包含页面索引的想法将不胜感激

我刚刚使用 Sphinx 创建了我的文档，这是我的问题：最初在 Toc 树指令中是空的，然后我在下面添加“教程”，它看起来像这样：

当我“制作 html”时，我没有在索引页面上获得“教程”。然后我在与 index.rst 相同的目录中创建了一个 tutorial.rst。我再次“制作 html”并收到以下错误消息：

toctree 包含对不存在文档的引用

我该如何解决 ？

我希望从标题编号继续获取列表编号。我已经尝试过 in 中的:numbered:指令.. toctree:，但这只会产生标题的数字。

例如：

这将产生：

1. Section

1.1 Sub Section

1.1.1 Item 1

1.1.2 Item 2

1.1.2.1 Item 3

产生这个结果的方法是什么（如果有的话）？

I'm working with Sphinx (sphinx-1.2b1-py2.7). I want a TOC to appear in a sidebar. It seems binary: I can only get both a TOC in the sidebar and a bulleted list in the body of the text, or I get nothing (no TOC in the sidebar and no bulleted list).

When I use the toctree directive like this:

Result: no TOC in the sidebar, no bulleted list of topics in body.

When I use the toctree directive like this:

Result: TOC in the sidebar AND a bulleted list of topics in the body.

I just want the TOC in the sidebar. Other commands (maxdepth, includehidden) don't work. I've seen it done, but cannot get it to work. The conf.py looks fine, but no luck after several days of searching for an answer. Thanks.

我开始使用 ext.autodoc 记录一些 python 类。我有几个 *.rst 文件，其内容如下

加上一个 index.rst：

'mymodule' 显示在目录中，但我也想查看目录中的类：

• 我的模块
  • 我的班级A
  • 我的班级B

如何让 sphinx 为每个班级创建类似部分的内容？还是有充分的理由不这样做？

谢谢

我正在 Sphinx 中生成 html 文档。

如何修改文档中每个 html 页面的侧边栏，以便它们包含目录树？默认情况下，目录树似乎只显示在master_doc页面中，并且只显示在主区域而不是侧边栏中。

是否有捷径可寻？我将使用 readthedocs 来托管生成的文档，所以我宁愿避免使用任何第三方插件，除非它们在 readthedocs 上也可用。

我正在使用 Sphinx 和我自己的模板来获得类似 twitter 引导文档的文档样式：http: //getbootstrap.com/2.3.2/getting-started.html

在那里您可以看到左侧的导航，它是静态的，并且在您滚动时保持在同一位置。

因此，有必要渲染我已经使用此功能实现的目录：

这给我输出了以下信息：

但为了让它与引导程序一起工作，我需要以下输出：

所以我的问题是：我怎样才能做到这一点？是否有toctree()我可以调整的功能的模板文件？

我有一个.. toctree作为狮身人面像页面的一部分，其中包括指向rst我的包中其他文件的相对链接。如何包含指向给定页面的子部分的链接，而不是整个页面本身？

我试了一下

但这没有用。任何帮助都很棒。