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 1.8+.
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 1.8+.
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.2rc1.tar.gz
(68.5 kB
view hashes)
Built Distribution
numpydoc-1.2rc1-py3-none-any.whl
(51.1 kB
view hashes)
Close
Hashes for numpydoc-1.2rc1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1d32d679fa64025e18adb074e6f8ca1b1301f5b9396ec37dc5963bc879885f54 |
|
| MD5 | 28007398f2346a805bcd99b6bcace0fb |
|
| BLAKE2b-256 | 48a83d395d356d5220d888fb0944b92ef1c7c18183b8ea571653e850bf8757ea |
