# numpydoc

**Repository Path**: vim_runtime_plugins/numpydoc

## Basic Information

- **Project Name**: numpydoc
- **Description**: 这个包提供了 numpydoc Sphinx 扩展，用于处理根据 NumPy 文档格式格式化的文档字符串。该扩展还添加了代码描述指令 np:function、np-c:function 等。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2021-12-19
- **Last Updated**: 2025-07-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

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

.. image:: https://readthedocs.org/projects/numpydoc/badge/?version=latest
   :alt: Documentation Status
   :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.9+ and sphinx 6+.

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.