Sphinx apidoc недостаточно автоматизирован

Question

Я работаю в большом репо с ~ 100 отдельными папками, каждая с 20-30 подпапками, каждая из которых содержит свои собственные папки .py.В настоящее время мне нужно создать файл .rst для каждого файла с помощью команды sphinx-apidoc, затем добавить путь к файлу conf.py, а затем добавить файл .rst в файл index.rst.Есть ли способ автоматизировать это так, чтобы все это делалось с помощью пары команд.

Answer 1

Расширение sphinx-autodoc указывает, что оно будет документировать пакеты Python. Пакеты Python в свою очередь требуют, чтобы их файлы (модули) содержались в каталоге, и чтобы каждый каталог содержал файл с именем __init__.py.

После правильной настройкиваши файлы и каталоги, тогда Sphinx может импортировать их и запустить sphinx-autodoc, как и ожидалось.