跳转到主要内容

Sphinx扩展,支持Numpy格式的文档字符串

项目描述

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

本包提供了用于处理按照NumPy文档格式编写的docstrings的numpydoc Sphinx扩展。该扩展还添加了代码描述指令np:functionnp-c:function等。

numpydoc需要Python 3.9+和sphinx 6+。

有关使用信息,请参阅文档

numpydoc docstring指南解释了如何为该扩展编写格式化的文档,而用户指南解释了如何在Sphinx中使用它。

项目详情


下载文件

下载适用于您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源代码发行版

numpydoc-1.8.0.tar.gz (90.4 kB 查看哈希)

上传时间 源代码

构建分发版

numpydoc-1.8.0-py3-none-any.whl (64.0 kB 查看哈希)

上传时间 Python 3

由以下机构支持