Repolode
提交项目
numpy

numpy/numpydoc

一个 Sphinx 扩展，用于解析 NumPy 格式的 docstring 并生成结构化的 API 文档。

在 GitHub 查看官网
Star
354
Fork
184
未关闭 Issue
135
最近提交
6天前

这是什么？

numpydoc 是一个 Sphinx 扩展，用于处理遵循 NumPy 文档格式编写的 docstring。它会把 Parameters、Returns、Raises、Examples 等段落转换为格式规范的 Sphinx 输出，让 Python 项目在整个代码库中保持统一的 docstring 风格。

除了解析 docstring，该扩展还新增了 np:function、np-c:function 等代码描述指令，用于以 NumPy 风格记录函数和 C 接口。项目中附带的 docstring 编写指南说明了如何编写可被该扩展正确处理的文档。

该包要求 Python 3.10 及以上版本和 Sphinx 6 及以上版本。

核心功能

  • 01解析 Parameters、Returns、Raises 等 NumPy 风格的 docstring 段落。
  • 02提供 np:function、np-c:function 等指令来记录代码对象。
  • 03以标准 Sphinx 扩展的形式集成到文档构建流程中。

适用场景

  • 为采用 NumPy 风格 docstring 的 Python 库生成 API 参考文档。
  • 结合 np-c 指令为 C 扩展函数编写文档，并与 Python 接口保持统一。

使用前须知

  • 仓库元数据无法识别其许可证，使用前请先查看 LICENSE 文件。

收录于专题

静态网站生成器与文档工具

标签

#sphinx#documentation#docstring#python#numpy

常见问题

numpydoc 是什么？
一个 Sphinx 扩展，用于解析 NumPy 格式的 docstring 并生成结构化的 API 文档。 numpydoc 是一个 Sphinx 扩展，用于处理遵循 NumPy 文档格式编写的 docstring。它会把 Parameters、Returns、Raises、Examples 等段落转换为格式规范的 Sphinx 输出，让 Python 项目在整个代码库中保持统一的 docstring 风格。
numpydoc 可以免费使用吗？用的什么许可证？
numpydoc 以 Other 许可证开源。用于商业产品前，请先确认许可证条款。
numpydoc 还在维护吗？
活跃维护中。numpydoc 最近一次提交是在 2026年11月1日。
numpydoc 适合用来做什么？
为采用 NumPy 风格 docstring 的 Python 库生成 API 参考文档。 结合 np-c 指令为 C 扩展函数编写文档，并与 Python 接口保持统一。
在哪里获取 numpydoc？
源代码和安装说明在 GitHub 上：https://github.com/numpy/numpydoc

概要由 AI 根据项目 README 生成；GitHub 数据每日更新。

相关项目