Skip to content

numpy/numpydoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

a36287a · Mar 11, 2025
Apr 27, 2024
Feb 3, 2025
Feb 15, 2025
Mar 11, 2025
Mar 11, 2025
Aug 8, 2023
Jul 2, 2023
May 11, 2024
Dec 23, 2024
Jan 6, 2025
Mar 11, 2025
Jan 10, 2025
Jul 2, 2023
Apr 30, 2022
Jul 24, 2024
Mar 22, 2024
Aug 9, 2019
Mar 11, 2025

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.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.