Документация по python sphinx

Question

Может кто-нибудь сказать мне, как этот проект может быть использован для целей документации http://sphinx.pocoo.org/

Я успешно установил его на моем компьютере с ОС CentOS. После установки в файле Readme говорится, что для запуска документации sphinx-quickstart требуется root /home/tom/Docs

Где отсюда, как я могу использовать команды в / home / Tom / Docs у меня есть файлы __buildconf.pyindex.rstmake.batMakefile_static_templates

Что дальше? Как создавать отчеты для моего проекта django, который находится в /usr/my-site

Answer 1

Ну, тебе придется немного почитать. Тем не менее, в качестве основного обзора:

• Обычно вы запускаете sphinx-quickstart в подпапке вашего проекта для документации (например, /usr/my-site/docs).
• Вы пишете документацию Sphinx в формате reStructuredText (rst). Начните с редактирования файла index.rst, и вы сможете добавить другие файлы позже.
• Когда вы закончите, используйте make html (или make.bat html в Windows) для создания HTML-файлов из вашего RST.