你如何修复狮身人面像在底部的警告？

我正在尝试将我的 Python 笔记放在 Sphinx 中。我将笔记放在与index.rst相同目录级别的单独文件中。

构建 HTML 后收到以下警告

警告

在

构建时的完整信息

我正在尝试使用它来构建sphinx-build . doc它给我警告：

可能是什么原因？

我对 Sphinx 很陌生，在服务器上记录我的项目。现在一位同事看到了我一直在做的事情，她想做同样的事情——在同一台服务器上记录她的项目。

这些项目不相关（它们不属于单个 TOCtree），我不知道如何帮助她。我可以配置 sphinx 来构建单独的文档树吗？是否像制作两个 Makefile 副本并设置不同的源/构建目录一样简单？

谢谢，--蒂姆

我正在使用 sphinx 自动生成 html 页面。目录真的很长，所以我试图在toctree的 div 中添加一个新的 html 类（除其他外），这样我就可以使用 javascript 库。基本上是想改变 toctree 生成其 HTML 的方式。

我找到了globaltoc.html文件，将其放在_templates文件夹中，并在conf.py中取消了template_path的注释。

这是_templates目录中的文件。

如果我这样做完全错误，请告诉我另一种方法。我希望能够在纯粹的 reST 中做到这一点，但这似乎是不可能的。我已经查看了有关 Sphinx 模板的有限示例，这就是我能找到的全部内容。

这样做的总体目标是将dhtmlxTree用于非常大的树。我已经将所需的 .js 文件和 .css 文件添加到layout.html。我只需要包含目录树的div就可以拥有我需要的类。我可以通过手动编辑得到我需要的结果，现在我需要自动化它。

谢谢你的帮助。

有谁知道按文件名降序排列 toctree 的任何选项？在升序的情况下，我们可以使用:glob:这样的选项：

这对于用重组文本编写的日常笔记非常方便，这些笔记应该在 Sphinx 文档中报告。

我是狮身人面像的新手。

该文件/home/user/myproject/docs/source/index.rst如下：

我在运行时收到以下$ make html消息/home/user/myproject/docs/：

我做错了什么？我希望 Sphinx 根据目录层次结构自动生成结构。

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

IE：

我试图在主project_spec.rst文档目录树中包含文件，如下所示：

但是，此错误消息会导致：

警告：toctree 包含对不存在文档 u'modules/module1/docs/module1' 的引用

不能以../某种方式在文档路径中使用吗？

更新：添加了 conf.py 位置

更新：除了下面的包含技巧之外，这仍然是（2019 年）不可能的。有一个未解决的问题不断推进：https ://github.com/sphinx-doc/sphinx/issues/701

我正在使用Sphinx生成文档。我可以更改目录中文档链接的标签

根据 toctree 指令在 toctree 指令中，但是如何对文档中的部分的链接执行相同的操作？

编辑 ：

这就是我想要实现的目标：

文档.rst

所以它Section - information会出现在目录中，但Info section会出现在文档本身中

i try to generate a documentation with Sphinx but the generation hangs on "preparing documents .." I search for a solution but I don't find any advice to solve the problem.

The problem appears after adding a Table of content to all files. The structure of the documentation looks like this :

a few Models: Every model has some Tables ( one file per table) example:

• Model = AUDITRAIL
• Tables = AUDITTRAIL_BFLOG.rst, AUDITTRAIL_SESSIONLOG.rst

AUDITRAIL.rst

AUDITTRAIL_SESSIONLOG.rst

AUDITTRAIL.SESSIONLOG

.. toctree:: :maxdepth: 1

AUDITTRAIL.rst

Keys and indexes

===== ===== ==================== seq type fields
===== ===== ==================== 1 P SESSIONLOGID 2 I USRID,SESSIONLOGID ===== ===== ====================

Fields

===== ==================== ===== ===== ========== =============== ==================== seq fieldname type inDB interface widgettype description
===== ==================== ===== ===== ========== =============== ==================== 5 CLIENTNAME S Y W20 EDITBOX Client name 4 COMPUTERNAME S
Y W20 EDITBOX Server name 6
CREDATIM E Y E8 EDITBOX Creation date field 11 DESCR S Y W1024
EDITBOXLONG Description field 10 LABEL S
Y W100 EDITBOX Label field 1
SESSIONLOGID N Y C10 EDITBOX Id field 8 UPDDATIM E Y E8
EDITBOX Update date field 2 USRID N
Y C10 EDITBOX id user 7
USRIDCRE N Y C10 EDITBOX Creation user id field 9 USRIDUPD N Y C10
EDITBOX Update user id field *3 USR_CODE S
N W30 EDITBOX * ===== ==================== ===== ===== ========== =============== ====================

I added a table of content on every table file to reference to the other tables from the same model. I hope somebody can help me.

Greeting, Mischa

我正在尝试使用 Sphinx 为大型 python 代码库自动创建 api 文档。

我尝试过使用 build_modules.py 和 sphinx-apidoc。使用任何一个，我都可以在我的输出目录中为包和顶级模块成功创建第一个文档。

但是，当我使用

它给出了数千个这种类型的错误：

对于代码库中的每个类和方法。通过一些实验，我想我发现 autosummary/autoclass 指令正在创建期望每个类和方法都有 rst 文件的目录树。

除了警告之外，文档似乎运行良好，但我想摆脱它们，我想我可能配置错误。

我也尝试过nipype/tools来达到同样的效果。

我修改了 apigen.py和build_modref_templates.py来为这些“缺失”的每个文档创建第一个存根，并根据需要使用 autoclass/autofunction/automethods。但是，构建需要相当长的时间（10 分钟），最终由于最后构建步骤中的内存错误而崩溃。

这是一个创建所有警告的示例模块 rst 文件：

感谢您提供有关如何解决这些警告的任何建议！我想远离任何涉及修改 sphinx 站点包文件的解决方案。