{"categories":[{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation"}],"enrichment":{"capability":"A Sphinx extension that parses and renders docstrings written in NumPy documentation format, adding specialized directives for function and code documentation.","skillfed_tags":["sphinx-extension","scientific-docs"],"use_cases":["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"],"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.\n\nYou 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.","worth_installing":"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."},"id":"numpydoc","links":{"html":"https://skillfed.io/packages/numpydoc","md":"https://skillfed.io/packages/numpydoc.md","pypi":"https://pypi.org/project/numpydoc/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2025-12-02","license_spdx":null,"license_treatment":"permissive","name":"numpydoc","python_support":"supports_current","summary":"Sphinx extension to support docstrings in Numpy format"},"popularity":{"monthly_downloads":2301154,"position":3156,"tier":"top_5000"},"security":{"n_vulnerabilities":0},"version":"1.10.0"}
