Автоматическое создание документации для всего содержимого пакета Python

Я пытаюсь автоматически сгенерировать базовую документацию для своей базы кода с помощью Sphinx. Однако у меня возникли трудности с указанием Sphinx рекурсивно сканировать мои файлы.

У меня есть кодовая база Python с такой структурой папок:

    src
        mypackage
            __init__.py
            subpackageA
                __init__.py
                submoduleA1
                submoduleA2
            subpackageB
                __init__.py
                submoduleB1
                submoduleB2

Я запустил sphinx-quickstart в , так что теперь моя структура выглядит так:

    src
        mypackage
            __init__.py
            subpackageA
                __init__.py
                submoduleA1
                submoduleA2
            subpackageB
                __init__.py
                submoduleB1
                submoduleB2
    index.rst
    _build
    _static
    _templates

Я прочитал краткое руководство http://sphinx.pocoo.org/tutorial.html , и хотя я все еще пытаюсь понять документацию, как она ' Формулировка этого слова заставляет меня беспокоиться, что Sphinx предполагает, что я собираюсь вручную создавать файлы документации для каждого отдельного модуля / класса / функции в моей кодовой базе.

Тем не менее, я заметил оператор "automdule" и включил autodoc во время быстрого запуска, поэтому я надеюсь, что большая часть документации может быть создана автоматически. Я изменил свой conf.py, чтобы добавить мою папку src в sys.path, а затем изменил свой index.rst, чтобы использовать automdule. Итак, теперь мой index.rst выглядит так:

Contents:

.. toctree::
   :maxdepth: 2

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. automodule:: alphabuyer
   :members:

У меня есть десятки классов и функций, определенных в подпакетах. Тем не менее, когда я запускаю:

sphinx-build -b html . ./_build

, он сообщает:

updating environment: 1 added, 0 changed, 0 removed

И, похоже, не удалось импортировать что-либо внутри моего пакета. При просмотре сгенерированного index.html рядом с «Contents:» ничего не отображается. На странице указателя отображается только «mypackage (модуль)», но щелчок по нему показывает, что он также не имеет содержимого. атрибут alt для этого изображения (также ...

Мы хотели бы запустить сканирование нашего сайта, возвращает отчет со следующим:

1. каждый найденный тег изображения и визуальное представление этого изображения в отчете;
2. атрибут alt для этого изображения (также определяет, не найден ли атрибут alt)

Есть ли простой инструмент для этого? Мы пытаемся проверить атрибуты alt и убедиться, что атрибуты alt точно описывают изображение, которое они представляют. Вот почему визуальное представление в отчете важно.