nb autodoc

NB-Autodoc

Упрощенный китайский английский

Введение

NB-Autodoc-это инструмент, который автоматически генерирует документы API из аннотаций и Docstring Python Python.

Этот инструмент находит все модули из пакета и импортирует их, анализирует абстрактное синтаксисное дерево, тип времени выполнения каждого модуля, связывает внутренние объекты, сигнатуры функций дисков и синтаксические деревья Docstring и, наконец, генерирует полный, надежный и на основе ссылок документ API.

Основные особенности

• Система анализа типа AST на основе AST

• Современные жанровые дисплеи, такие как X | Y , list[str] , (*args) -> Any

• Заглушка (.pyi) Поддержка

• Поддержка type_cecking

• Поддержка реэкспорта, импортные ссылки из AST

• Поддержка функции перегрузки перегрузки

Использование

Установите из PIP:

 pip install nb-autodoc

Запустить NB-Autodoc:

 nb-autodoc {package_name}

Другие параметры командной строки:

 Usage: nb-autodoc [OPTIONS] MODULE

Options:
  -o, --output-dir DIRECTORY      [default: build]
  -s, --skip TEXT                 skip import modules
  -u, --undoc TEXT                undocument modules
  --markdown-linkmode [heading_id|vuepress]
                                  [default: heading_id]
  --help                          Show this message and exit.

Совет: Используйте --undoc вместо --skip , который пропустит импорт и анализ модулей.