Sphinx extension to support docstrings in Numpy format
Project Links
Meta
Author: Pauli Virtanen and others
Requires Python: >=3.9
Classifiers
Development Status
- 5 - Production/Stable
Environment
- Plugins
Intended Audience
- Developers
License
- OSI Approved :: BSD License
Operating System
- OS Independent
Programming Language
- Python
- Python :: 3
- Python :: 3.9
- Python :: 3.10
- Python :: 3.11
- Python :: 3.12
- Python :: 3.13
Topic
- Documentation
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.9+ and sphinx 6+.
For usage information, please refer to the documentation.
The numpydoc docstring guide explains how to write docs formatted for this extension, and the user guide explains how to use it with Sphinx.
1.9.0
Jun 24, 2025
1.9.0rc0
Jun 24, 2025
1.8.0
Aug 09, 2024
1.8.0rc2
Jul 24, 2024
1.8.0rc1
Jul 24, 2024
1.7.0
Mar 28, 2024
1.7.0rc0
Mar 22, 2024
1.6.0
Sep 26, 2023
1.6.0rc2
Aug 21, 2023
1.6.0rc1
Jul 07, 2023
1.6.0rc0
Jun 29, 2023
1.5.0
Oct 08, 2022
1.5.0rc1
Oct 04, 2022
1.4.0
Jun 09, 2022
1.4.0rc1
Jun 08, 2022
1.3.1
Apr 30, 2022
1.3
Apr 29, 2022
1.3rc1
Apr 25, 2022
1.2.1
Mar 29, 2022
1.2
Jan 24, 2022
1.2rc1
Jan 21, 2022
1.1.0
Jul 01, 2020
1.0.0
May 26, 2020
0.9.2
Dec 24, 2019
0.9.1
Apr 23, 2019
0.9.0
Apr 21, 2019
0.8.0
Mar 30, 2018
0.7.0
Jun 20, 2017
0.6.0
Feb 13, 2016
0.5
Jun 08, 2014
0.4
Oct 01, 2010
0.3.1
Nov 14, 2009
0.2
Sep 21, 2009
0.1
Apr 01, 2009
