Описание тега epydoc
Epydoc - это инструмент для создания документации API для модулей Python на основе их строк документации.
Автоматический генератор справочной документации на Python. Epydoc обрабатывает модули и строки документации Python для создания отформатированной документации API в виде HTML-страниц. Epydoc можно использовать через интерфейс командной строки (epydoc.cli) и графический интерфейс (epydoc.gui). Оба интерфейса позволяют пользователю указать набор модулей или других объектов для документирования и создать документацию по API, используя следующие шаги:
- Извлекайте основную информацию об указанных объектах и связанных с ними объектах (например, значениях, определенных модулем). Это можно сделать с помощью интроспекции, синтаксического анализа или того и другого:
- Самоанализ импортирует объекты и исследует их напрямую, используя механизмы самоанализа Python.
- Анализ читает исходные файлы Python, которые определяют объекты, и извлекает информацию из этих файлов.
- Объедините и обработайте эту информацию.
- Слияние: объедините информацию, полученную в результате самоанализа и анализа каждого объекта, в единую структуру.
- Связывание: замените все "указатели", созданные для импортированных переменных, документацией, на которую они указывают.
- Именование: присвойте уникальные канонические имена каждому из указанных объектов и всем связанным объектам.
- Строки документации: проанализируйте строки документации каждого из указанных объектов.
- Наследование: добавляйте переменные в классы для любых значений, которые они наследуют от своих базовых классов.
- Создать вывод. Вывод может быть создан в различных форматах: