Как веб-сайт Python генерирует онлайн-документацию? - PullRequest
10 голосов

Создано с использованием Sphinx 0.6.5.

Я знаю, что в документации Python используется reStructuredText, но в ней есть разные разделы, такие как http://docs.python.org/whatsnew/2.6.html и http://docs.python.org/tutorial/index.html.

Как вы делаете это в reStructuredText? Вы запускаете rst2html в куче каталогов, сохраняя свою структуру?

Я знаю, что он использует Sphinx (не rst2html напрямую, как сказал Thomas Wouters в ответе ), но как вы должны организовать свою первую структуру с файлами исходного кода в репозитории, чтобы у вас был полный рост автоматизированный сайт документации?

Ответы [ 3 ]

9 голосов
/ 18 мая 2010

Документация Python использует reST для разметки , но он генерирует HTML, используя sphinx, а не rst2html напрямую. Инструмент sphinx - это то, что преобразует все отдельные файлы .rst в несколько файлов .html. Чтобы увидеть, как генерируются документы Python, см. http://svn.python.org/projects/python/trunk/Doc/Makefile

4 голосов
/ 18 мая 2010

Я нашел учебник sampledoc на сайте matplotlib весьма полезным для начала работы со Sphinx.

2 голосов
/ 12 февраля 2014
...