Skip to content

numpy/numpydoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

7300108 · Mar 29, 2022
Oct 22, 2021
Jan 21, 2022
Mar 29, 2022
Mar 29, 2022
Dec 15, 2020
Aug 9, 2019
Mar 29, 2022
May 26, 2020
Jan 10, 2022
Jan 25, 2022
Aug 9, 2019
Aug 19, 2020
Mar 29, 2022
Jun 24, 2020

Repository files navigation

numpydoc -- Numpy's Sphinx extensions

Documentation Status https://github.com/numpy/numpydoc/actions/workflows/test.yml/badge.svg?branch=main

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.

The numpydoc docstring guide explains how to write docs formatted for this extension, and the user guide explains how to use it with Sphinx.