Skip to main content

Sphinx extension to support docstrings in Numpy format

Project description

=====================================
numpydoc -- Numpy's Sphinx extensions
=====================================

.. image:: https://readthedocs.org/projects/numpydoc/badge/?version=latest
:alt: Documentation Status
:scale: 100%
:target: https://numpydoc.readthedocs.io/en/latest/

.. image:: https://codecov.io/gh/numpy/numpydoc/branch/main/graph/badge.svg
:target: https://app.codecov.io/gh/numpy/numpydoc/branch/main

.. image:: https://github.com/numpy/numpydoc/actions/workflows/test.yml/badge.svg?branch=main
:target: https://github.com/numpy/numpydoc/actions/workflows/test.yml

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
<https://numpydoc.readthedocs.io/>`_.

The `numpydoc docstring guide
<https://numpydoc.readthedocs.io/en/latest/format.html>`_ explains how
to write docs formatted for this extension, and the `user guide
<https://numpydoc.readthedocs.io>`_ 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.6.0.tar.gz (85.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

numpydoc-1.6.0-py3-none-any.whl (61.7 kB view details)

Uploaded Python 3

File details

Details for the file numpydoc-1.6.0.tar.gz.

File metadata

  • Download URL: numpydoc-1.6.0.tar.gz
  • Upload date:
  • Size: 85.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for numpydoc-1.6.0.tar.gz
Algorithm Hash digest
SHA256 ae7a5380f0a06373c3afe16ccd15bd79bc6b07f2704cbc6f1e7ecc94b4f5fc0d
MD5 227e5a257f4bfe488a257d963c2df5bc
BLAKE2b-256 5fed5ca4b2e90f4b0781f5fac49cdb2947cf719b6d289eedb67e8b1a63d019e3

See more details on using hashes here.

File details

Details for the file numpydoc-1.6.0-py3-none-any.whl.

File metadata

  • Download URL: numpydoc-1.6.0-py3-none-any.whl
  • Upload date:
  • Size: 61.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for numpydoc-1.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b6ddaa654a52bdf967763c1e773be41f1c3ae3da39ee0de973f2680048acafaa
MD5 851557437e256b1489e40579397e14d3
BLAKE2b-256 9c9409c437fd4a5fb5adf0468c0865c781dbc11d399544b55f1163d5d4414afb

See more details on using hashes here.

Supported by

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