PyCon US is happening May 14th-22nd in Pittsburgh, PA USA.  Learn more

Sphinx extension to support docstrings in Numpy format

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Eric89GXL from gravatar.com Eric89GXL Avatar for jarrodmillman from gravatar.com jarrodmillman Avatar for jnothman from gravatar.com jnothman Avatar for pv from gravatar.com pv Avatar for rgommers from gravatar.com rgommers

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: BSD License (Copyright (C) 2008-2023 Stefan van der Walt <stefan@mentat.za.net>, Pauli Virtanen <pav@iki.fi> Red...)
  • Author: Pauli Virtanen and others
  • Tags sphinx, numpy
  • Requires: Python >=3.9
  • Provides-Extra: developer, doc, test
Classifiers
Report project as malware

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

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page