Как веб-сайт Python создает свою онлайн-документацию?
Создано с использованием 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 в ответе), но как вы должны организовать свою первую структуру с файлами исходного кода в репозиторий, так что у вас есть полностью автоматизированный веб-сайт doc-сайта?
Ответы
Ответ 1
Документация Python использует reST для своей разметки, но она генерирует HTML, используя sphinx
, а не rst2html
напрямую. Инструмент sphinx
- это то, что преобразует все отдельные файлы .rst
в несколько файлов .html
. Чтобы узнать, как сгенерированы документы Python, см. http://svn.python.org/projects/python/trunk/Doc/Makefile
Ответ 2
Я нашел учебник sampledoc на сайте matplotlib, весьма полезный для начала работы с Sphinx.
Ответ 3
Вот как правильно составить документацию Python.