В генераторе док-станции Sphinx я могу добавить целый пакет (рекурсивно) к индексу?

144
14

Я хочу создать документацию для моего пакета. Каждый файл в проекте содержит обширную документацию. Есть ли способ быстро добавить весь мой проект в индекс documetation?


Я хотел бы автоматически генерировать некоторую документацию для всего проекта с минимальной работой. Я начал с добавления следующего к index.rst:


.. automodule:: mymodulename
:members:

Все, что было сделано, это документы в файле __init__.py (только docstring) - есть ли способ сделать это документом для всего остального? Я хочу добавить абсолютно все, что определено в моем пакете, и добавить в соответствующий индекс каждый отдельный класс, константу, функцию (и т.д.) В пакете.


Можно ли это сделать?

спросил(а) 2012-01-09T20:35:00+04:00 8 лет, 8 месяцев назад
1
Решение
169

Вы можете использовать sphinx-apidoc.

Из официальной документации : sphinx-apidoc - это инструмент для автоматической генерации источников Sphinx, который, используя расширение autodoc, документирует весь пакет в стиль других инструментов автоматической документации API.


Пример использования может быть (из корневого каталога проекта):


$ sphinx-apidoc . --full -o doc -H 'MyProject' -A 'MyName' -V '1.0'

Каталог

A doc будет создан со всем, что готово внутри.

Вы также можете настроить параметры вашей документации, отредактировав автоматически сгенерированный файл conf.py.


Другую полезную информацию можно найти в подобном вопросе, размещенном здесь.

ответил(а) 2012-01-09T21:09:00+04:00 8 лет, 8 месяцев назад
Ваш ответ
Введите минимум 50 символов
Чтобы , пожалуйста,
Выберите тему жалобы:

Другая проблема