Могу ли я добавить в индекс весь пакет в генераторе документов Sphinx?

Question

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

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

.. automodule:: mymodulename
    :members:

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

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

Answer 1

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

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

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

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

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