numpydoc
Sphinx extension to support docstrings in Numpy format
Decision gist · record as of 2026-08-14
Yes. numpydoc is actively maintained, has no known vulnerabilities, installs with low friction, and is essential if you document scientific Python code using NumPy-format docstrings. The permissive BSD license poses no restrictions. Install it as part of your Sphinx setup if your project or team uses NumPy docstring conventions.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10+ and Sphinx 6+; must be configured in a Sphinx project's conf.py
- Low friction installation with a pure-Python wheel.
- Actively maintained with recent commits and no known vulnerabilities.
License · maintenance · safety
permissive license (permissive) — BSD 2-Clause permissive license allows use in commercial and private projects with minimal restrictions; only requires copyright notice and disclaimer in distributions.
last release 2025-12-02 (255 days) · last repo commit 2026-08-09 · 352 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 2,301,154 downloads/mo, #3,156 on PyPI
Alternatives
Verify before relying
pip install numpydoc
# In conf.py (Sphinx configuration):
extensions = ['numpydoc']
# Then write NumPy-format docstrings in your code- Whether the extension handles all NumPy docstring edge cases or has known limitations with specific formats
- Performance characteristics when processing large codebases with many NumPy-format docstrings
What it is and what it does
numpydoc is a Sphinx extension that teaches Sphinx how to read and render docstrings written in NumPy's standardized documentation format. It parses sections like Parameters, Returns, Examples, and Notes, converting them into properly formatted HTML or other Sphinx output formats. The extension also provides specialized directives (np:function, np-c:function, etc.) for documenting NumPy-style code.
You install it as a dependency of your Sphinx documentation project, add it to your conf.py extensions list, and then write your code docstrings following the NumPy format guide. Sphinx will automatically use numpydoc to render them. It depends on Sphinx and tomli, making it a lightweight addition to existing documentation workflows.
Use it for
- Documenting scientific Python libraries that follow NumPy's docstring conventions
- Converting existing NumPy-format docstrings into polished HTML API documentation via Sphinx
- Adding specialized code directives (np:function, np-c:function) to Sphinx projects documenting NumPy-adjacent code
- Enforcing consistent docstring structure across a team's scientific Python codebase
- Building documentation sites for projects that inherit or adopt NumPy's documentation standards
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
numpydoc is actively maintained, has no known vulnerabilities, installs with low friction, and is essential if you document scientific Python code using NumPy-format docstrings. The permissive BSD license poses no restrictions. Install it as part of your Sphinx setup if your project or team uses NumPy docstring conventions.
Install
numpydoc on PyPI
Before you install
Low friction installation with a pure-Python wheel. Actively maintained with recent commits and no known vulnerabilities. Requires Python 3.10+ and Sphinx 6+.
Requires Python 3.10+ and Sphinx 6+; must be configured in a Sphinx project's conf.py
License in practice
BSD 2-Clause permissive license allows use in commercial and private projects with minimal restrictions; only requires copyright notice and disclaimer in distributions.
Quickstart
pip install numpydoc
# In conf.py (Sphinx configuration):
extensions = ['numpydoc']
# Then write NumPy-format docstrings in your codeVerify before relying
- Whether the extension handles all NumPy docstring edge cases or has known limitations with specific formats
- Performance characteristics when processing large codebases with many NumPy-format docstrings
Package facts
| License | permissive license permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 2 packagessphinxtomli |
| Maintenance | Actively maintained 255 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 2,301,154 / month, #3,156 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableEnvironment :: PluginsIntended Audience :: DevelopersLicense :: OSI Approved :: BSD LicenseOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Topic :: Documentation |
Evidence: numpydoc-1.10.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “numpy docstring sphinx extension”
- numpydocA Sphinx extension that parses and renders docstrings written in…
- sphinxcontrib-napoleonA Sphinx extension that converts Google and NumPy style docstrings…
- sphinx-autodoc-typehintsAutomatically extracts Python type hints from your code and injects…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
See also docstring-parser · sphinxcontrib-napoleon · docstring-parser-fork · sphinx-data-viewer · pydoctor · darglint · docstring-inheritance · pydoc-markdown · pydoclint · pdoc3