126得票8回答
Sphinx可以链接到不在根文档目录下的文档吗?

我正在使用 Sphinx 来记录一个非 Python 项目。我希望在每个子模块中分发 ./doc 文件夹,其中包含用于记录该模块的 submodule_name.rst 文件。然后,我想将这些文件吸入到主层次结构中,以创建整个设计的规范。 即:Project docs spec ...

87得票5回答
警告:文档未包含在任何toctree中,以用于包含的文件。

我收到了警告: WARNING: document isn't included in any toctree 对于因明确包含而存在于文档中的文件。因此,我有索引文件: .. toctree:: :maxdepth: 2 pages/0010-foo pages/...

53得票5回答
Sphinx自动摘要中“toctree包含对不存在文档的引用”的警告

我正在尝试使用Sphinx自动为一个大型Python代码库创建API文档。 我已经尝试过使用build_modules.py和sphinx-apidoc。使用其中任何一种工具,我都能够成功地在我的输出目录中创建rst文档,用于包和顶级模块。 但是,当我使用以下命令构建时:make html...

49得票4回答
如何在每个页面的侧边栏中包含toctree

我正在使用Sphinx生成HTML文档。 如何修改每个HTML页面的侧边栏,使其包括toctree?默认情况下,toctree似乎只在master_doc页面中显示,并且仅在主区域而不是侧边栏中显示。 有没有简单的方法来实现这一点?我将使用readthedocs来托管生成的文档,因此我希望...

40得票4回答
如何在Sphinx中展开侧边栏TOC树中的所有子部分?

我在想是否有一种方法可以展开在index.rst文件中包含的标题下的所有子部分? 例如,这是它的显示方式:Section 1 Section 2 Section 3 以下是我希望它成为的样子:Section 1 Subsection 1.1 Subsection 1.2 Subs...

34得票2回答
如何在Sphinx的目录中包含主页?

假设我有一个Sphinx项目,其中包含以下源代码:index.rst installation.rst templating/ index.rst module.rst fieldtype.rst index.rst(主页)具有以下目录树:.. toctree:: ...

33得票1回答
禁用个别 Sphinx 警告消息

我在Sphinx目录中有许多.rst文件,这些文件故意被排除在任何索引树之外。我收到的警告信息如下: /filename.rst:: WARNING: document isn't included in any toctree 我该如何在Sphinx中禁止特定的警告?

26得票1回答
未知指令类型“toctree”。在Pycharm中出现错误,但index.html可以正常工作。

在PyCharm中工作时,我在Sphinx中创建的文档的预览模式显示为: System Message: ERROR/3 (<stdin>, line 9) Unknown directive type "toctree". ..toctree:: :ma...

26得票1回答
无法在Sphinx中显示TOCTREE链接

我是 Sphinx 的新手。我尝试了教程,但是无法在目录中生成链接。我遇到的错误是: C:\Users\mhaikalm\sphinxtest\source\index.rst:11: WARNING: toctree contains refe rence to document 'int...

25得票4回答
Sphinx toctree指令中的外部相对链接

我正在使用Sphinx构建我的文档。我正在使用其他工具进行API参考。我把我的文档放在一个目录里面,而将API参考放在该目录中名为api的子目录中。 我希望在文档中有一个指向API参考的链接。我能够在我的toctree链接中添加一个链接: TBD.. toctree:: :maxde...