问题标签 [toctree]

我使用 Sphinx 和 autosummary 来生成 Python 软件的文档。它运行良好，但生成的 .rst 文件还列出了导入的函数和类，这不是我想要的行为。

例如带有文档字符串的包“packageex”：

会产生一个文件 packageex.module0.rst

有没有办法只列出模块中定义的函数和类（而不是那些导入的）？

在 autodoc ( http://sphinx-doc.org/latest/ext/autodoc.html ) 的文档中，有“在带有 members 选项集的 automodule 指令中，只有其__module__属性等于模块名称的模块成员为给自动模块将被记录。这是为了防止记录导入的类或函数。如果要防止这种行为并记录所有可用成员，请设置导入成员选项。请注意，导入模块的属性不会被记录，因为属性文档是通过解析当前模块的源文件发现的。” 是否可以使用自动摘要获得相同的行为？

我正在尝试使用 sphinx 来记录文档的多个“级别”，例如：

• 接口参考
• 手动的
• 教程
• 等等。

这个想法是，目录显示在相对于您所在部分的侧边栏上。因此，当您在主索引上时，它仅显示上述部分。当你进入例如。“手动”它显示了特定于该部分的不同 ToC，以及返回主 ToC 的方法。

我一直在试图弄清楚如何在不入侵的情况下让它在 Sphinx 中工作，但到目前为止还不太清楚。文件夹结构已经反映了不同的部分（即所有“手册”文档都存储在 _source/manual 下），我尝试在每个目录中放置单独的索引文件，但似乎 toctree 功能只查看主索引文件。

我正在使用“readthedocs”主题，我正在查看的代码是https://github.com/snide/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/layout.html#L93

谁能告诉我如何使用 Sphinx 添加这样的 ToC？

谢谢

我希望我在 sphinx 中的目录树包含主（index.rst）页面。文件建议包含'self'会这样做，但正如其他人在stackoverflow上指出的那样，这仅包括主页的标题，因此如果深度> 1，则主页的行为与链接页面不同。

我还看到了针对这个问题建议的内容指令，对我来说，这只是创建了一个单独的本地内容列表，对目录树没有帮助。我真的在寻找一种在目录树中产生一致行为的解决方案。有吗？

我正在使用 sphinx-apidoc 和 autosummary 扩展来记录库的 API，但我真的无法理解以下generated/选项的目的：

我已经看到这是 Sphinx 文档，在 pandas 等库中。我正在使用toctree并且我的 API 正在自动生成，但我不明白生成的是什么。我没有看到一个名为 generate 的文件夹，也不知道这样做的好处/目的是什么。

谢谢

据我了解，新的 Read The Docs 主题从深度为 2 的目录树生成侧边栏。我的文档相对较深，深度为 2 不足以使其有用。我怎样才能增加这个限制，或者最好完全删除它？

如果这不合理，我如何使用本地 ToC 而不是全局目录树？

我经常生成的 sphinx HTML 文档在从 fedora 20 更新到 21 后突然停止显示目录树。模板仍然没有改变，并且包含

它曾经创建一个目录树，但现在在生成的 div 中看不到目录的证据。

没有给出警告或错误，所以我真的不知道从哪里开始寻找。有谁知道最近在 sphinx 中可能发生了什么变化来创建这种行为？

- 更新 -

{{ toctree() }} 调用不会产生任何输出，无论其在模板中的位置如何，因此“侧边栏”位似乎并不重要。

I use sphynx to generate documentation from static .rst files (no docstrings extraction).

I have two files in my repository:

index.rst

and intro.rst

Below is screenshot of pdf obtained by running sphinx-build -b latex . _build; cd _build; pdflatex * :

Flabbergasting or what?

我正在使用Sphinx来构建我的文档。我正在使用其他工具进行 API 参考。我在一个目录中有我的文档，其中的目录名称 api 中有 API 参考。

我想要从文档到 API 参考的链接。我可以向我的目录树链接添加一个链接，以便：

问题是我不想放完整路径，我只想放相对路径api/

如何使用相对路径而不是绝对路径来链接到外部资源？

我不确定这是否可能。但我希望将多个 .rst 文件放在一个目录中，并在编译期间。我希望这些文件自动插入到toctree. 我该怎么办？

有没有办法在 Sphinx 文档的左侧菜单中添加章节标题？我知道如果您使用 MkDocs（例如此处）可以做到这一点，但有没有办法在 Sphinx 和 ReSTructured 文本中做到这一点？

我想将我的文档分成单独的部分（例如安装说明、运行程序等），这些部分的标题在左侧菜单中显示为文本。