Skip to content

cmarmo/numpydoc

This branch is 74 commits behind numpy/numpydoc:main.

Folders and files

NameName
Last commit message
Last commit date
Aug 17, 2023
Jan 1, 2024
Dec 13, 2023
Nov 16, 2023
Aug 17, 2023
Aug 8, 2023
Jul 2, 2023
May 10, 2022
Aug 9, 2019
Jan 2, 2024
Jun 29, 2023
Jul 2, 2023
Jul 2, 2023
Apr 30, 2022
Jun 9, 2023
Jul 2, 2023
Aug 9, 2019
Aug 17, 2023

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.8+ and sphinx 5+.

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.

About

Numpy's Sphinx extensions

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.9%
  • Makefile 0.1%