Автоматизация документации Django с помощью Sphinx

Я использую Sphinx для создания документации для проекта Django, и он работает очень хорошо. Однако представляется необходимым написать файлы .rst самостоятельно, и как только это будет сделано, sphinx скомпилирует документацию из строк документации, когда вы запустите make HTML.

Мои вопросы: я ищу документы, чтобы автоматически отражать новые дополнения к проекту без необходимости редактировать файлы .rst вручную.

Поскольку все в Django всегда кажется таким простым, мне кажется странным, что вам нужно создавать первые файлы для всего проекта вручную, я бы подумал, что есть что-то, что уже существует, что автоматически проверяет структуру проекта и создает первое оттуда.

Я просмотрел этот проект http://pypi.python.org/pypi/django-sphinx-autodoc/0.0, который выглядит многообещающе, но я удивлен, что нет ничего более зрелого.


person Giles Smith    schedule 07.08.2012    source источник


Ответы (1)


С некоторых пор APIDOC Sphinx входит в состав Sphinx. Это может создать для вас полный набор .rst файлов.

Это становится большей проблемой, если вы хотите задокументировать все различные приложения django, которые вы используете, на одном сайте (похоже, это то, что вы хотите). Sphinx apidoc хочет, чтобы несколько каталогов сканировались на наличие пакетов python.

person Reinout van Rees    schedule 18.11.2012