Описание тега sphinx-apidoc
NoneSphinx-apidoc - это инструмент командной строки для автоматической генерации источников Sphinx reStructuredText, который с расширением Sphinx autodoc документирует весь пакет в стиле других инструментов автоматической документации API.
sphinx-apidoc это инструмент для автоматической генерации исходных текстов Sphinx, которые документируют весь пакет.
Использование sphinx-apidoc команда выглядит следующим образом:
sphinx-apidoc [OPTIONS] -o <OUTPUT_PATH> <MODULE_PATH> [EXCLUDE_PATTERN …]
Sphinx-apidoc использует autodoc для извлечения строк документации из исходных файлов (расположенных в<MODULE_PATH>) и помещает полученный .rst файлы reStructuredText вOUTPUT_PATH. Позднее документация может быть создана из этих.rst файлы в несколько форматов, таких как HTML, PDF, используя sphinx-build.
Документация sphinx-apidoc можно найти здесь.
См. Также: autodoc