Skip to content

stefanv/numpydoc

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

Folders and files

NameName
Last commit message
Last commit date

Latest commit

29b9eed · Dec 31, 2017
Nov 26, 2017
Dec 31, 2017
Sep 13, 2016
Oct 22, 2017
Nov 1, 2017
Oct 22, 2017
Dec 27, 2016
Oct 22, 2017
Nov 1, 2017

Repository files navigation

https://travis-ci.org/numpy/numpydoc.png?branch=master

numpydoc -- Numpy's Sphinx extensions

Numpy's documentation uses several custom extensions to Sphinx. These are shipped in this numpydoc package, in case you want to make use of them in third-party projects.

The numpydoc extension provides support for the Numpy docstring format in Sphinx, and adds the code description directives np:function, np-c:function, etc. that support the Numpy docstring syntax.

See numpydoc docstring guide for how to write docs that use this extension, and the user guide

Numpydoc inserts a hook into Sphinx's autodoc that converts docstrings following the Numpy/Scipy format to a form palatable to Sphinx.

About

Numpy's Sphinx extensions

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%