2014-01-15 2 views
1

Шаблоны Sphinx, которые я использую (например, sphninxdoc или sphinx13), имеют ссылку на файл 'contents.rst'; однако, хотя этот файл documented as "special", я не вижу способа его создания.Как заставить Sphinx генерировать 'contents.rst'?

Есть ли способ получить Sphinx для генерации 'contents.rst' автоматически, или мне нужно сгенерировать его вручную?

ответ

2

«Особый» contents.rst файл, указанный в вопросе не генерируется автоматически. Он написан как любой другой файл reST и хранится в репозитории Python: https://github.com/python/cpython/blob/master/Doc/contents.rst.

Питон документация на главную страницу http://docs.python.org/release/2.7/index.html имеет Complete Table of Contents ссылку, указывающую на contents.html, который построен из contents.rst.

Источник для Sphinx documentation содержит похожие содержимое.rst: https://github.com/sphinx-doc/sphinx/blob/master/doc/contents.rst.

Смежные вопросы