sphinx-apidoc - Интернет в облаке

ПРОГРАММА:

ИМЯ

sphinx-apidoc - инструмент для создания документов API Sphinx

СИНТАКСИС

сфинкс-апидок [кредита] -овыходной каталог>источник> [пути ...]

ОПИСАНИЕ

сфинкс-апидок это инструмент для автоматической генерации исходных текстов Sphinx, который с помощью autodoc
расширение, документируйте весь пакет в стиле другой автоматической документации API
инструментов.

источник должен указывать на пакет Python. Любой пути даны пути, которые следует исключить
из поколения.

ПРЕДУПРЕЖДЕНИЕ:
сфинкс-апидок генерирует исходные файлы, использующие сфинкс.ext.autodoc документировать все найденное
модули. Если какие-либо модули имеют побочные эффекты при импорте, они будут выполнены автодок
когда сфинкс запущен.

Если вы документируете сценарии (в отличие от библиотечных модулей), убедитесь, что их основная процедура
защищен if __название__ == '__главный__' состояние.

ДОПОЛНИТЕЛЬНЫЕ ОПЦИИ

-o
Каталог для размещения выходных файлов. Если его нет, он создается.

-f, --сила
Обычно apidoc не перезаписывает файлы, если не задана эта опция.

-l, --фолловые ссылки
Переходите по символическим ссылкам.

-n, --прогон, репетиция
Если задан, apidoc не создает никаких файлов.

-s
Суффикс для сгенерированных исходных файлов, по умолчанию Первое.

-d
Максимальная глубина для созданного файла оглавления.

-T, - нет
Не создавайте файл оглавления.

-F, --полный
Если задано, создается полный проект Sphinx (conf.py, Makefile и т. д.) с помощью
сфинкс-быстрый старт.

-e, --отдельный
Поместите каждый файл модуля на отдельную страницу.

-E, --без заголовков
Не создавайте заголовки для модулей / пакетов

-P, --частный
Включите модули "_private"

Эти параметры используются с -F:

-H
Название проекта, которое нужно ввести в конфигурацию.

-A
Имя (а) автора, которое нужно добавить в конфигурацию.

-V
Версия проекта.

-R
Релиз проекта.

Используйте sphinx-apidoc онлайн с помощью сервисов onworks.net