Skip to main content

Sphinx extension to support docstrings in Numpy format

Project description

Documentation Status https://codecov.io/gh/numpy/numpydoc/branch/main/graph/badge.svg 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 3.0+.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

numpydoc-1.4.0.tar.gz (70.3 kB view hashes)

Uploaded source

Built Distribution

numpydoc-1.4.0-py3-none-any.whl (51.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page