Sphinx：modules.rst：警告：文档未包含在任何 toctree 中

Question

正在尝试使用 Sphinx 生成文档。

首次使用：sphinx-apidoc 然后使用：sphinx-build html

我收到了关于 modules.rst 文件的警告。文件存在，html也生成了，肯定是table的内容。

我阅读了我能找到的关于该主题的所有主题，none 解决了问题（使用 .. include:: 指令在 index.rst 文件中正确定位模块声明.. .)

我不知道该怎么做才能让它发挥作用

这是我的 index.rst 文件的副本，也许您会看到一些我没有看到的内容。生成的第一个文件位于 sources 文件夹

Welcome to documentation!
=====================================
    
.. toctree::
   :maxdepth: 4
   :caption: Contents:

   modules

   
Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

我也收到这条消息：

..\doc\sphinx\index.rst:4: WARNING: toctree contains reference to nonexisting document u'modules'

如果我用另一个文档替换模块，我会得到以下信息：

\doc\sphinx\index.rst:4: WARNING: toctree contains reference to nonexisting document u'opsimtest'
looking for now-outdated files... none found
pickling environment... done
checking consistency... \doc\sphinx\_apidocs\modules.rst: WARNING: document isn't included in any toctree

所以看起来即使我在 toctree 中命名另一个文档，它仍在寻找 modules.rst（并且看不到另一个文档，但是它被内置到 html 文件中）

在本主题中：Can't get sphinx to link under toctree to another document 错误消息指出 intro.rst 而不是 modules.rst。编辑：正如我所说，不幸的是，我已经阅读了其他主题，但它们并没有解决我的问题。还是坏了。

Answer 1

在 reST 中，白色 space 有意义。该指令及其选项必须与其内容用空行分隔。

.. toctree::
    :maxdepth: 4
    :caption: Contents:

    _apidocs/modules

Sphinx：modules.rst：警告：文档未包含在任何 toctree 中

Sphinx: modules.rst: WARNING: document isn't included in any toctree

python

python-sphinx

toctree