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.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.
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.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.
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.0rc2.tar.gz
(83.1 kB
view details)
Built Distribution
File details
Details for the file numpydoc-1.6.0rc2.tar.gz.
File metadata
- Download URL: numpydoc-1.6.0rc2.tar.gz
- Upload date:
- Size: 83.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 23f4ef62b1116dba2737b54e5c31e0ab4e0932f2310e4beac6a3efd01b3c4a79 |
|
| MD5 | 8d1641e7ef971ab9f383f27eebfdf3d6 |
|
| BLAKE2b-256 | 25cd2ad15e78ee13f73941284e51f82419570b8afc75177d191f9899735c189f |
Provenance
File details
Details for the file numpydoc-1.6.0rc2-py3-none-any.whl.
File metadata
- Download URL: numpydoc-1.6.0rc2-py3-none-any.whl
- Upload date:
- Size: 60.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 02e4c5f4482024d3b7dc6761dfd4dd465626d97329fe723fb69087fbd7ab3ab4 |
|
| MD5 | 0e6e4392d79038b17c815ab11eab0650 |
|
| BLAKE2b-256 | f8e2466982438e459a828b665679336dc8804bacb4a8f709452915db8eeeca04 |
