{"categories":[{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"}],"enrichment":{"capability":"sphinx-autodoc2 generates API documentation for Python packages through static code analysis, without requiring package installation, and supports both reStructuredText and Markdown docstrings.","skillfed_tags":["static-analysis","api-documentation"],"use_cases":["Generate API documentation for a Python package without installing it, useful for documenting packages from external sources or avoiding dependency conflicts.","Migrate documentation from reStructuredText to Markdown docstrings incrementally while maintaining both formats in the same project.","Build documentation in a CI/CD pipeline where caching speeds up rebuilds during development iterations.","Document only the public API by leveraging `__all__` declarations, keeping generated docs focused and maintainable.","Analyze and document packages outside of Sphinx using the standalone autodoc2 command-line tool."],"what_it_does":"sphinx-autodoc2 is a Sphinx extension that generates API documentation by analyzing Python code statically, without needing to import or install the target package. It parses source files directly using astroid, extracts docstrings (supporting both reStructuredText and Markdown), and respects `__all__` declarations to document only the public API. The analysis and rendering are decoupled, so you can use it outside Sphinx via a command-line tool.\n\nThe extension is optimized for development workflows through caching of analysis and rendering, and correctly handles Python typing constructs like `if TYPE_CHECKING` blocks. It supports mixed docstring formats within the same project and offers extensive configuration options. Three runtime dependencies (astroid, tomli, typing-extensions) keep the install footprint small, and the codebase uses type annotations and function-based rendering instead of complex templates.","worth_installing":"Yes. sphinx-autodoc2 is a solid choice if you need automatic API documentation for Python packages. It has low install friction, active maintenance, no known vulnerabilities, permissive licensing, and solves real pain points (static analysis, Markdown support, `__all__` handling) that motivated its creation. The 991-day gap since the last release is offset by recent repository activity, suggesting the project is stable rather than abandoned."},"id":"sphinx-autodoc2","links":{"html":"https://skillfed.io/packages/sphinx-autodoc2","md":"https://skillfed.io/packages/sphinx-autodoc2.md","pypi":"https://pypi.org/project/sphinx-autodoc2/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2023-11-27","license_spdx":null,"license_treatment":"permissive","name":"sphinx-autodoc2","python_support":"supports_current","summary":"Analyse a python project and create documentation for it."},"popularity":{"monthly_downloads":305085,"position":7799,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.5.0"}