Repolode
Предложить
numpy

numpy/numpydoc

Расширение Sphinx, которое разбирает docstring в стиле NumPy и преобразует их в структурированную документацию API.

Открыть на GitHubСайт
Звёзды
354
Форки
184
Открытые issues
135
Последний коммит
6 дней назад

Что это?

numpydoc — это расширение Sphinx для обработки docstring, написанных в формате документации NumPy. Оно преобразует такие разделы, как Parameters, Returns, Raises и Examples, в корректно оформленный вывод Sphinx, чтобы во всём коде Python-проектов использовался единый стиль docstring.

Помимо разбора docstring, расширение добавляет директивы для описания кода, например np:function и np-c:function, которые позволяют документировать функции и C API в стиле NumPy. Руководство по docstring NumPy, входящее в состав проекта, объясняет, как писать docstring, совместимые с расширением.

Для работы пакета требуется Python 3.10 или новее и Sphinx 6 или новее.

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

  • 01Разбирает разделы docstring в стиле NumPy, например Parameters, Returns и Raises.
  • 02Добавляет директивы np:function и np-c:function для документирования объектов кода.
  • 03Интегрируется с Sphinx как стандартное расширение.

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

  • Создание справочной документации API для библиотеки Python, использующей docstring в стиле NumPy.
  • Документирование функций C-расширений с помощью директив np-c наряду с API на Python.

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

  • Не удалось определить лицензию по метаданным репозитория. Перед повторным использованием проверьте файл LICENSE.

В подборках

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

Темы

#sphinx#documentation#docstring#python#numpy

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

Что такое numpydoc?
Расширение Sphinx, которое разбирает docstring в стиле NumPy и преобразует их в структурированную документацию API. numpydoc — это расширение Sphinx для обработки docstring, написанных в формате документации NumPy. Оно преобразует такие разделы, как Parameters, Returns, Raises и Examples, в корректно оформленный вывод Sphinx, чтобы во всём коде Python-проектов использовался единый стиль docstring.
numpydoc можно использовать бесплатно? Какая у него лицензия?
numpydoc распространяется с открытым исходным кодом под лицензией Other. Перед использованием в коммерческих продуктах проверьте условия лицензии.
numpydoc всё ещё поддерживается?
Активно поддерживается. Последний коммит в numpydoc — 1 нояб. 2026 г..
Для чего можно использовать numpydoc?
Создание справочной документации API для библиотеки Python, использующей docstring в стиле NumPy. Документирование функций C-расширений с помощью директив np-c наряду с API на Python.
Где скачать numpydoc?
Исходный код и инструкции по установке — на GitHub: https://github.com/numpy/numpydoc

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

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