Sphinx extension to support docstrings in Numpy format
Project description
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.
The numpydoc docstring guide explains how to write docs formatted for this extension, and the user guide explains how to use it with Sphinx.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
numpydoc-1.6.0.tar.gz
(85.5 kB
view details)
Built Distribution
numpydoc-1.6.0-py3-none-any.whl
(61.7 kB
view details)
File details
Details for the file numpydoc-1.6.0.tar.gz.
File metadata
- Download URL: numpydoc-1.6.0.tar.gz
- Upload date:
- Size: 85.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ae7a5380f0a06373c3afe16ccd15bd79bc6b07f2704cbc6f1e7ecc94b4f5fc0d |
|
| MD5 | 227e5a257f4bfe488a257d963c2df5bc |
|
| BLAKE2b-256 | 5fed5ca4b2e90f4b0781f5fac49cdb2947cf719b6d289eedb67e8b1a63d019e3 |
Provenance
File details
Details for the file numpydoc-1.6.0-py3-none-any.whl.
File metadata
- Download URL: numpydoc-1.6.0-py3-none-any.whl
- Upload date:
- Size: 61.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b6ddaa654a52bdf967763c1e773be41f1c3ae3da39ee0de973f2680048acafaa |
|
| MD5 | 851557437e256b1489e40579397e14d3 |
|
| BLAKE2b-256 | 9c9409c437fd4a5fb5adf0468c0865c781dbc11d399544b55f1163d5d4414afb |
