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 4.2+.
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 4.2+.
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.5.0.tar.gz
(71.9 kB
view details)
Built Distribution
numpydoc-1.5.0-py3-none-any.whl
(52.4 kB
view details)
File details
Details for the file numpydoc-1.5.0.tar.gz.
File metadata
- Download URL: numpydoc-1.5.0.tar.gz
- Upload date:
- Size: 71.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.8.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b0db7b75a32367a0e25c23b397842c65e344a1206524d16c8069f0a1c91b5f4c |
|
| MD5 | ec7dc7d9ac9e83ac3fd8722aca25bc5c |
|
| BLAKE2b-256 | 2759e9ee6fc936961fd7012167c8a3191599206deec2e6e26882f1dd1b42b761 |
Provenance
File details
Details for the file numpydoc-1.5.0-py3-none-any.whl.
File metadata
- Download URL: numpydoc-1.5.0-py3-none-any.whl
- Upload date:
- Size: 52.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.8.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c997759fb6fc32662801cece76491eedbc0ec619b514932ffd2b270ae89c07f9 |
|
| MD5 | 384b95c1893632b657706c6b6d8d6c1d |
|
| BLAKE2b-256 | c481ad9b8837442ff451eca82515b41ac425f87acff7e2fc016fd1bda13fc01a |
