Sphinx extension to support docstrings in Numpy format
Project description
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 following extensions are available:
numpydoc: support for the Numpy docstring format in Sphinx, and add the code description directives np:function, np-c:function, etc. that support the Numpy docstring syntax.
numpydoc.traitsdoc: For gathering documentation about Traits attributes.
numpydoc.plot_directive: Adaptation of Matplotlib’s plot:: directive. Note that this implementation may still undergo severe changes or eventually be deprecated.
See A Guide to NumPy/SciPy Documentation for how to write docs that use this extension.
numpydoc
Numpydoc inserts a hook into Sphinx’s autodoc that converts docstrings following the Numpy/Scipy format to a form palatable to Sphinx.
Options
The following options can be set in conf.py:
numpydoc_use_plots: bool
Whether to produce plot:: directives for Examples sections that contain import matplotlib.
numpydoc_show_class_members: bool
Whether to show all members of a class in the Methods and Attributes sections automatically. True by default.
numpydoc_show_inherited_class_members: bool
Whether to show all inherited members of a class in the Methods and Attributes sections automatically. If it’s false, inherited members won’t shown. True by default.
numpydoc_class_members_toctree: bool
Whether to create a Sphinx table of contents for the lists of class methods and attributes. If a table of contents is made, Sphinx expects each entry to have a separate page. True by default.
numpydoc_edit_link: bool (DEPRECATED – edit your HTML template instead)
Whether to insert an edit link after docstrings.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file numpydoc-0.7.0.tar.gz.
File metadata
- Download URL: numpydoc-0.7.0.tar.gz
- Upload date:
- Size: 19.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2dc7b2c4e3914745e38e370946fa4c109817331e6d450806285c08bce5cd575a |
|
| MD5 | 727b7c87d5a8e4e7576af475c20b9c55 |
|
| BLAKE2b-256 | 21940e087bd669bb69da3b0996acfee97cee9f7d91c825991ad76eb863dc020d |
