问题标签 [toctree]

我可以使用 recommonmark 在 Sphinx 中渲染我的 Readme.md 文件。但是当我尝试在 .rst 文件 toctree 中放入多个自述文件时，只能从文档链接访问第一个。

我可以在文件夹结构中看到这两个自述文件，但是当尝试从呈现的 html 页面访问它们时，链接不起作用。

这是文件夹结构的图像。

任何帮助表示赞赏，谢谢！

这是 Sphinx 构建中弹出的错误 -

/workspace/kick_device2/kick/kvm/kvm.rst:16：警告：toctree 包含对没有标题的文档“kick/kvm/tests/README”的引用：不会生成链接

所以我正在为我的库编写 PHP 文档。我正在使用“sphinxcontrib.phpdomain”扩展来支持 PHP 域。

假设我定义了以下文档：

是否可以由此生成 TOC 树？例如，我想在树中索引类名和类成员。

目前，只有自定义标题在目录树中被索引

我正在使用出色的 Sphinx 工具来创建一些文档，并且我试图通过将同一部分的章节分成单独的文件来保持代码库的模块化形式。（有关“章节”和“部分”的定义，请参见此处。）

我尝试使用两个文件来做到这一点test1.rst：

和test2.rst：

它们包含在index.rst这样的范围内：

但是，在构建时，第 2 章不会嵌套在第 1 部分中。这是为什么呢？有没有办法做到这一点，而不必创建一个脚本来将它们附加到一个文件中，如下例所示？

例子：

我正在尝试开始使用 Sphinx 来记录 Python，但我似乎错过了一些非常基本的入门步骤。

我正在关注http://www.sphinx-doc.org/en/stable/tutorial.html并已安装和配置（尽可能使用默认值）该工具。

问题是我无法将另一个 RST 文件链接到索引。我的索引文件如下：

请注意，intro.rst 与以下内容位于同一目录中：

输出类型为 html。当我尝试

我收到一条警告说：

我希望在 index.html 中创建一个带有“intro”字符串的超链接，链接指向 intro.html

相反，在 index.html 文件的预期位置中只有一个字符串“intro”。请注意，创建了 intro.html 文件，但不是从 index.html 超链接

有人可以建议我错过了什么看似很小的一步吗？

I want to use Sphinx's autosummary extension and templates to generate API docs recursively from docstrings. I want separate pages for each module, class, method, property and function. But it doesn't detect my templates at all. In fact, if I just remove the module.rst file from _templates/autosummary/, it renders the whole file exactly the same way as before. I've followed this SO question to the letter. If you're interested, the full repository is on GitHub.

Edit: It seems it does generate a different file, I had to delete docs/_autosummary for it to read the new template. However, now it generates a file with the sparse header and description header. It doesn't go into the {% if classes %} and {% if functions %} directives.

My directory structure is as follows:

• sparse
• docs
  • conf.py
  • index.rst
  • modules.rst
  • _templates/autosummary/module.rst

Here are the relevant files so far:

index.rst:

modules.rst:

_templates/autosummary/module.rst:

我正在使用 Sphinx 为存储库生成文档。Sphinxtoctree允许使用:glob:来自动选择某些文档。

我有一个表格的目录树

第一个*获取所有不同模块的位置/some/repository/structure，我想要以 . 开头的模块中的所有文档acme_corp_。

但是，当目录树输出时，这会同时获取包和模块。我试过使用_generated/some/repository/structure/*/doc/acme_corp_*package，但没有输出匹配的链接（因为我猜这个词package实际上并没有出现在路径中）。

如何让 Sphinx 自动生成一个maxdepth: 1 toctree这样我只能在结果目录中获取包？

我有几个相互独立的文件：

我想foo.rst从访问index.rst，但我希望这两个子文档从 1 开始编号。

在index.rst我有：

但是， bar 会取这个数字2.，然后bar.rst我会得到2.1 Tomatoes.

我想要这个渲染：

这怎么可能？

我正在使用 sphinx 文档系统生成 HTML 和 Latex 输出格式的报告。所以有一个层次结构，我有一个读取 index.rst ，其中包含一个按出现顺序引用所有章节的目录树。然后一章是一个文件夹，其中还包含一个 index.rst，只有一个标题和一个包含该章所有部分的目录树。

例如，我的结构如下所示：

这可以用乳胶很好地呈现，因为你会从字面上得到 someChapter 和下面的部分，但在 html 中，这些都是单独的页面，对于一些较小的小节来说很快就会很无聊，因为你必须不断点击。有没有办法指示 html 构建器在某些情况下应该在它们在目录树中的同一页面中显示子页面，而不是为其创建子页面？

我知道 singlehtml，但它确实为它构建了一个完整的单个 html 页面，我想部分地这样做，因为很多时候不同的章节在不同的页面上都很棒，但部分可以很容易地在同一个页面上。

任何帮助表示赞赏。

我一直在使用 Sphinx 为我的代码制作一个很好的文档，我想知道是否可以在目录旁边放置一个图像（而不是一个没有任何东西的大空白）

目前，我初学者的 index.rst 文件如下所示：

提前致谢。

目前我这样做：

配置文件：

参考.rst：

这将为每个模块生成一个概览表，每个模块的条目都很好地链接到详细信息页面。

我有两个问题：

1. 我真的必须枚举每个模块吗？
2. 如何控制详细信息页面的选项？

广告1.：我想做这样的事情（目前不起作用）：

（或者也许是一个新autopackage命令。）

广告 2.：我想传递那些automodule或autoclass期望的选项，例如：

这似乎是一项显而易见的任务，所以我可能遗漏了一些信息。有没有一种简单的替代方法来实现这一点？