sphinxcontrib-napoleon
Sphinx "napoleon" extension.
Decision gist · record as of 2026-08-14
No. This package is abandoned (last release 2018-09-23) and superseded by the built-in sphinx.ext.napoleon in Sphinx 1.3+. Unless you are maintaining legacy documentation on Sphinx <= 1.2, use the built-in extension instead. For modern Sphinx, simply add 'sphinx.ext.napoleon' to your extensions list.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Sphinx must be installed and configured; this extension is primarily useful for Sphinx versions <= 1.2 (for newer Sphinx, use the built-in sphinx.ext.napoleon instead).
- Low friction to install with only two runtime dependencies (six and pockets).
- However, the package is abandoned—last release was 2018-09-23.
License · maintenance · safety
BSD (permissive) — BSD license is permissive and poses no restrictions on use, modification, or distribution in proprietary or open-source projects.
last release 2018-09-23 (2882 days)
0 known vulnerabilities (OSV.dev, 2026-08-14) · 391,139 downloads/mo, #7,017 on PyPI
Alternatives
Verify before relying
pip install sphinxcontrib-napoleon
# In conf.py:
extensions = ['sphinxcontrib.napoleon']
# Then write docstrings in Google or NumPy style; Sphinx autodoc will parse them automatically.- Whether the package remains compatible with modern Python versions or recent Sphinx releases, given its 2018 final release.
- Whether the built-in sphinx.ext.napoleon in current Sphinx versions has feature parity or if edge cases still require this backport.
What it is and what it does
sphinxcontrib-napoleon is a Sphinx extension that preprocesses docstrings written in Google or NumPy style and converts them to reStructuredText before Sphinx parses them. This allows developers to write cleaner, more readable docstrings without the verbose reStructuredText markup (e.g., `:param name: description` becomes `Args: name: description`), while still generating properly formatted API documentation.
The extension integrates into Sphinx's autodoc workflow and automatically recognizes specially formatted sections like Args, Returns, Raises, Examples, and many others. It supports both Google-style (indentation-based) and NumPy-style (underline-based) docstring formats. However, this package is now obsolete: Sphinx has included Napoleon as a built-in extension since version 1.3, making this separate package unnecessary for modern projects.
Use it for
- Migrating from verbose reStructuredText docstrings to Google-style docstrings in a Sphinx project using Sphinx <= 1.2.
- Maintaining legacy documentation builds that depend on sphinxcontrib-napoleon and cannot upgrade to modern Sphinx.
- Converting NumPy-style docstrings to reStructuredText for API documentation generation in older projects.
- Enabling consistent docstring parsing across Google and NumPy styles in a single Sphinx build.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
No.
This package is abandoned (last release 2018-09-23) and superseded by the built-in sphinx.ext.napoleon in Sphinx 1.3+. Unless you are maintaining legacy documentation on Sphinx <= 1.2, use the built-in extension instead. For modern Sphinx, simply add 'sphinx.ext.napoleon' to your extensions list.
Install
sphinxcontrib-napoleon on PyPI
Before you install
Low friction to install with only two runtime dependencies (six and pockets). However, the package is abandoned—last release was 2018-09-23. Since Sphinx 1.3, Napoleon is built into Sphinx itself, making this backport unnecessary for modern projects.
Sphinx must be installed and configured; this extension is primarily useful for Sphinx versions <= 1.2 (for newer Sphinx, use the built-in sphinx.ext.napoleon instead).
License in practice
BSD license is permissive and poses no restrictions on use, modification, or distribution in proprietary or open-source projects.
Quickstart
pip install sphinxcontrib-napoleon
# In conf.py:
extensions = ['sphinxcontrib.napoleon']
# Then write docstrings in Google or NumPy style; Sphinx autodoc will parse them automatically.Verify before relying
- Whether the package remains compatible with modern Python versions or recent Sphinx releases, given its 2018 final release.
- Whether the built-in sphinx.ext.napoleon in current Sphinx versions has feature parity or if edge cases still require this backport.
Package facts
| License | BSD permissive |
| Python support | Not specified |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 2 packagessixpockets |
| Maintenance | Abandoned 2,882 days since the last release |
| First released | |
| Downloads | 391,139 / month, #7,017 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 :: ConsoleEnvironment :: Web EnvironmentFramework :: SphinxFramework :: Sphinx :: ExtensionIntended Audience :: DevelopersLicense :: OSI Approved :: BSD LicenseOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 2Programming Language :: Python :: 3Topic :: DocumentationTopic :: Utilities |
Evidence: sphinxcontrib_napoleon-0.7-py2.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 › “sphinx docstring parser”
- sphinxcontrib-napoleonA Sphinx extension that converts Google and NumPy style docstrings…
- numpydocA Sphinx extension that parses and renders docstrings written in…
- docstring-parserParses Python docstrings in ReST, Google, Numpydoc, and Epydoc…
Give your agent the search over MCP, or paste the wish link into any chat.
More Utilities packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Detects and normalizes text encoding from unknown or ambiguous sources, supporting all IANA character sets that Python's core library provides codecs for, with the ability to register custom codecs.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
Pluggy provides a plugin system that lets you define hook specifications and register implementations to be called in sequence, enabling extensible Python applications without tight coupling.
Install it if you're building an extensible application or framework.
Pygments is a syntax highlighter that colorizes source code and text in over 500 languages and formats, outputting to HTML, LaTeX, RTF, SVG, images, or ANSI terminal sequences.
Install it if you need to display or transform source code.
Six provides utility functions to write Python code that runs on both Python 2.7 and Python 3.3+, smoothing over language differences between the two versions.
See also numpydoc · docstring-to-markdown · darglint · sphinxcontrib-django · sphinxcontrib-confluencebuilder · sphinx-sitemap · sphinx-autodoc-typehints · sphinx-autodoc2 · sphinxcontrib-htmlhelp · m2r2