Repolode
Предложить
tox-dev

tox-dev/sphinx-autodoc-typehints

Расширение для Sphinx, которое переносит подсказки типов Python в поля параметров и возвращаемых значений autodoc, поддерживая ссылки и stub-файлы.

Открыть на GitHubСайт
Звёзды
588
Форки
115
Открытые issues
0
Последний коммит
вчера

Что это?

sphinx-autodoc-typehints — расширение для Sphinx autodoc: оно читает подсказки типов в документируемом коде Python и добавляет их в поля параметров и возвращаемых значений сгенерированной документации. Разработчикам достаточно указать каждый тип в коде один раз, не дублируя его в docstring.

Расширение добавляет ссылки на документацию к каждой части типа и разрешает имена, импортированные только внутри блока `if TYPE_CHECKING:` или объявленные в stub-файлах `.pyi`. Оно также документирует варианты `@overload` и значения по умолчанию, а ещё умеет обрабатывать docstring в стилях Google и NumPy, используемые с napoleon или numpydoc.

В документации проекта расширение сравнивается со встроенной настройкой Sphinx `autodoc_typehints`. Среди различий — типизация `**kwargs` через `TypedDict`, описания `Annotated[..., Doc(...)]` и уведомления `@deprecated`.

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

  • 01Переносит подсказки типов из кода в поля параметров и возвращаемых значений autodoc.
  • 02Добавляет ссылки на документацию к каждой части типа.
  • 03Разрешает имена, импортированные внутри блока TYPE_CHECKING, и объявленные в stub-файлах .pyi.
  • 04Документирует варианты @overload и значения по умолчанию.
  • 05Типизирует именованные аргументы из TypedDict через **kwargs: Unpack[...].
  • 06Поддерживает docstring в стилях Google и NumPy, а также napoleon и numpydoc.

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

  • Документирование типизированной библиотеки Python с помощью Sphinx autodoc.
  • Отображение типов из stub-файлов .pyi для C-расширений без аннотаций.
  • Поддержание актуальности документации API за счёт аннотаций типов вместо их дублирования в docstring.

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

  1. 1

    Установите расширение из PyPI

    pip install sphinx-autodoc-typehints
  2. 2

    Добавьте расширение в conf.py после sphinx.ext.autodoc

В подборках

Генераторы статических сайтов и инструменты для документации

Темы

#sphinx#python#documentation#type-hints#autodoc#typehints

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

Что такое sphinx-autodoc-typehints?
Расширение для Sphinx, которое переносит подсказки типов Python в поля параметров и возвращаемых значений autodoc, поддерживая ссылки и stub-файлы. sphinx-autodoc-typehints — расширение для Sphinx autodoc: оно читает подсказки типов в документируемом коде Python и добавляет их в поля параметров и возвращаемых значений сгенерированной документации. Разработчикам достаточно указать каждый тип в коде один раз, не дублируя его в docstring.
sphinx-autodoc-typehints можно использовать бесплатно? Какая у него лицензия?
sphinx-autodoc-typehints распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.
sphinx-autodoc-typehints всё ещё поддерживается?
Активно поддерживается. Последний коммит в sphinx-autodoc-typehints — 6 нояб. 2026 г..
Для чего можно использовать sphinx-autodoc-typehints?
Документирование типизированной библиотеки Python с помощью Sphinx autodoc. Отображение типов из stub-файлов .pyi для C-расширений без аннотаций. Поддержание актуальности документации API за счёт аннотаций типов вместо их дублирования в docstring.
Как установить sphinx-autodoc-typehints?
Установите расширение из PyPI: pip install sphinx-autodoc-typehints Добавьте расширение в conf.py после sphinx.ext.autodoc
Где скачать sphinx-autodoc-typehints?
Исходный код и инструкции по установке — на GitHub: https://github.com/tox-dev/sphinx-autodoc-typehints

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты