尝试使用Sphinx生成文档。
首次使用:sphinx-apidoc
然后使用:sphinx-build html
我收到了关于modules.rst
文件的警告。文件存在,html也生成了,它看起来绝对像一个内容表。
我阅读了我能找到的关于该主题的每一个主题,没有一个能解决问题(使用.. include::
指令,在index.rst
文件中正确定位模块解密…(
我不知道该怎么做才能让工作
这是我的index.rst
文件的副本,也许你会看到我没有的东西。生成的rst文件位于sources
文件夹中
Welcome to documentation!
=====================================
.. toctree::
:maxdepth: 4
:caption: Contents:
modules
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
我还收到这样的消息:
..docsphinxindex.rst:4: WARNING: toctree contains reference to nonexisting document u'modules'
如果我用另一个文档替换模块,我会得到以下内容:
docsphinxindex.rst:4: WARNING: toctree contains reference to nonexisting document u'opsimtest'
looking for now-outdated files... none found
pickling environment... done
checking consistency... docsphinx_apidocsmodules.rst: WARNING: document isn't included in any toctree
因此,即使我在toctree中命名另一个文档,它仍然在寻找模块。rst(没有看到其他文档,但它是构建在html文件中的(
在本主题中:Can';t让sphinx在toctree下链接到另一个文档-错误消息状态为intro.rst
而不是modules.rst
。编辑:正如我所说,不幸的是,我已经阅读了其他线程,它们并没有解决我的问题。它还是坏了。
在reST中,空白是有意义的。指令及其选项必须用空行与其内容分隔开。
.. toctree::
:maxdepth: 4
:caption: Contents:
_apidocs/modules