如何让Sphinx生成' contents.rst'?

时间:2014-01-15 23:36:22

标签: python documentation python-sphinx

我使用的Sphinx模板(例如sphninxdocsphinx13)有一个指向'contents.rst'文件的链接;但是,虽然这个文件是documented as "special",但我没有看到生成它的方法。

有没有办法让Sphinx自动生成'contents.rst',还是需要手动生成?

2 个答案:

答案 0 :(得分:2)

问题中提到的“特殊” contents.rst 文件不会自动生成。它的编写方式与任何其他reST文件类似,并存储在Python存储库中:https://github.com/python/cpython/blob/master/Doc/contents.rst

http://docs.python.org/release/2.7/index.html上的Python文档主页有一个Complete Table of Contents链接,指向 contents.html ,它是从contents.rst构建的。

Sphinx documentation的来源包含类似的内容。第一名:https://github.com/sphinx-doc/sphinx/blob/master/doc/contents.rst

答案 1 :(得分:1)

当我进入此页面时,我需要修复.readthedocs.yml。我的狮身人面像配置路径缺少“源”部分:

# Build documentation in the docs/ directory with Sphinx
sphinx:
  configuration: docs/source/conf.py

在配置中,我有

# The master toctree document.
master_doc = 'index'