.. image:: https://readthedocs.org/projects/numpydoc/badge/?version=latest :alt: Documentation Status :scale: 100% :target: https://numpydoc.readthedocs.io/en/latest/
.. image:: https://codecov.io/gh/numpy/numpydoc/branch/main/graph/badge.svg :target: https://app.codecov.io/gh/numpy/numpydoc/branch/main
.. image:: https://github.com/numpy/numpydoc/actions/workflows/test.yml/badge.svg?branch=main :target: https://github.com/numpy/numpydoc/actions/workflows/test.yml
This package provides the numpydoc Sphinx extension for handling
docstrings formatted according to the NumPy documentation format.
The extension also adds the code description directives
np:function, np-c:function, etc.
numpydoc requires Python 3.8+ and sphinx 5+.
For usage information, please refer to the documentation <https://numpydoc.readthedocs.io/>_.
The numpydoc docstring guide <https://numpydoc.readthedocs.io/en/latest/format.html>_ explains how
to write docs formatted for this extension, and the user guide <https://numpydoc.readthedocs.io>_ explains how to use it with Sphinx.
FAQs
Sphinx extension to support docstrings in Numpy format
We found that numpydoc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST's new password guidelines remove periodic changes and special character requirements, focusing on longer, more secure passwords for better authentication practices.
Security News
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
