.. 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.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.
