pdoc3/pdoc

Что это?

Ключевые возможности

• 01Генерирует HTML-документацию по файлу модуля, каталогу пакета или пути импорта.
• 02Поддерживает docstring в форматах Markdown, numpydoc и стиле Google.
• 03Обрабатывает аннотации типов PEP 484 и PEP 526.
• 04Наследует docstring переопределённых членов класса.
• 05Автоматически создаёт перекрёстные ссылки на упоминаемые идентификаторы.
• 06Поддерживает пользовательские шаблоны и встроенный сервер для просмотра документации в реальном времени.

Сценарии использования

• Публикация справочной документации API для библиотеки на Python.
• Генерация удобной для просмотра документации внутреннего пакета на Python без дополнительной настройки.
• Предварительный просмотр отображения docstring во время написания документации.

Быстрый старт

1. 1

   Установите pdoc3 из PyPI

   pip install pdoc3
2. 2

   Создайте документацию для своего проекта

   pdoc your_project

Что важно знать

• !Пакет в PyPI называется pdoc3, а не pdoc, поэтому устанавливайте его именно под этим именем.
• !Лицензия AGPL-3.0 — лицензия с сильным копилефтом, которая может ограничивать использование в проектах с закрытым исходным кодом.

В подборках

Темы

Частые вопросы

Что такое pdoc?

Автоматически генерирует документацию API для проектов на Python 3 по модулям, пакетам и docstring без специальной настройки. pdoc — это инструмент командной строки, который генерирует HTML-документацию API для проектов на Python. Достаточно указать файл модуля, каталог пакета или путь импорта — и pdoc отобразит публичные объекты, их docstring и аннотации типов.

pdoc можно использовать бесплатно? Какая у него лицензия?

pdoc распространяется с открытым исходным кодом под лицензией AGPL-3.0. Перед использованием в коммерческих продуктах проверьте условия лицензии.

pdoc всё ещё поддерживается?

Обновлялся за последние 6 месяцев. Последний коммит в pdoc — 15 авг. 2026 г..

Для чего можно использовать pdoc?

Публикация справочной документации API для библиотеки на Python. Генерация удобной для просмотра документации внутреннего пакета на Python без дополнительной настройки. Предварительный просмотр отображения docstring во время написания документации.

Как установить pdoc?

Установите pdoc3 из PyPI: pip install pdoc3 Создайте документацию для своего проекта: pdoc your_project

Где скачать pdoc?

Исходный код и инструкции по установке — на GitHub: https://github.com/pdoc3/pdoc