如何让 Sphinx 生成“contents.rst”？

Question

我使用的 Sphinx 模板（例如sphninxdoc或sphinx13 ）有一个指向“contents.rst”文件的链接； 但是，尽管此文件被记录为 "special" ，但我看不到生成它的方法。

有没有办法让 Sphinx 自动生成“contents.rst” ，还是我需要手动生成它？

Answer 1

当我来到这个页面时，我需要修复.readthedocs.yml 。 我的 sphinx 配置路径缺少“源”部分：

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

在配置中，我有

# The master toctree document.
master_doc = 'index'

Answer 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 文档主页有一个完整的目录链接，指向contents.html ，它是从 contents.rst 构建的。