Sphinx extension to support docstrings in Numpy format
Project description
=====================================
numpydoc -- Numpy's Sphinx extensions
=====================================
.. 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.7+ and sphinx 3.0+.
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.
numpydoc -- Numpy's Sphinx extensions
=====================================
.. 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.7+ and sphinx 3.0+.
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.
Project details
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.4.0.tar.gz
(70.3 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
numpydoc-1.4.0-py3-none-any.whl
(51.9 kB
view details)
File details
Details for the file numpydoc-1.4.0.tar.gz.
File metadata
- Download URL: numpydoc-1.4.0.tar.gz
- Upload date:
- Size: 70.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9494daf1c7612f59905fa09e65c9b8a90bbacb3804d91f7a94e778831e6fcfa5
|
|
| MD5 |
86cf0118745aead47416ff22e88cad63
|
|
| BLAKE2b-256 |
d6fbdce2345676623f26ea9a8c9a8c3485a4ea232cb598a6f5e8be8d32947bed
|
File details
Details for the file numpydoc-1.4.0-py3-none-any.whl.
File metadata
- Download URL: numpydoc-1.4.0-py3-none-any.whl
- Upload date:
- Size: 51.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fd26258868ebcc75c816fe68e1d41e3b55bd410941acfb969dee3eef6e5cf260
|
|
| MD5 |
1efaa34a87a955a99908fb63aa3829b9
|
|
| BLAKE2b-256 |
e71a9e3c2a34aae5bd1ab8988b238aafeb4c8d3ab312b8aa5a8c37be6c6d869d
|