https://github.com/numpy/numpydoc

Numpy's Sphinx extensions
https://github.com/numpy/numpydoc

Last synced: 7 months ago
JSON representation

Numpy's Sphinx extensions

• Host: GitHub
• URL: https://github.com/numpy/numpydoc
• Owner: numpy
• License: other
• Created: 2013-07-24T16:23:39.000Z (over 12 years ago)
• Default Branch: main
• Last Pushed: 2025-05-01T16:57:50.000Z (7 months ago)
• Last Synced: 2025-05-07T22:30:35.117Z (7 months ago)
• Language: Python
• Homepage: https://numpydoc.readthedocs.io/
• Size: 764 KB
• Stars: 321
• Watchers: 31
• Forks: 166
• Open Issues: 118
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
=====================================

numpydoc -- Numpy's Sphinx extensions

=====================================

.. image:: https://readthedocs.org/projects/numpydoc/badge/?version=latest

   :alt: Documentation Status

   :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.9+ and sphinx 6+.

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.