{"categories":[{"label":"Utilities","url":"https://skillfed.io/packages/category/utilities/6"},{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation"}],"enrichment":{"capability":"A Sphinx extension that converts Google and NumPy style docstrings into reStructuredText, making documentation source code more readable during the build process.","skillfed_tags":["docstring-formatting","sphinx-extension","legacy"],"use_cases":["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."],"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.\n\nThe 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.","worth_installing":"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."},"id":"sphinxcontrib-napoleon","links":{"html":"https://skillfed.io/packages/sphinxcontrib-napoleon","md":"https://skillfed.io/packages/sphinxcontrib-napoleon.md","pypi":"https://pypi.org/project/sphinxcontrib-napoleon/"},"maintenance":{"status":"abandoned"},"meta":{"latest_release":"2018-09-23","license_spdx":null,"license_treatment":"permissive","name":"sphinxcontrib-napoleon","python_support":"unspecified","summary":"Sphinx \"napoleon\" extension."},"popularity":{"monthly_downloads":391139,"position":7017,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.7"}
