{"categories":[{"label":"Utilities","url":"https://skillfed.io/packages/category/utilities/7"},{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation"},{"label":"Documentation","url":"https://skillfed.io/packages/category/software-development-documentation"}],"enrichment":{"capability":"Generates API documentation for Python 3+ projects automatically from source code and docstrings, supporting multiple docstring formats and type annotations.","skillfed_tags":["api-documentation","docstring-parser","code-generation"],"use_cases":["Generate API documentation for open-source Python packages without maintaining separate doc configuration or build steps.","Create quick reference documentation during development using the built-in web server for instant preview.","Document internal Python projects where minimal configuration and automatic cross-linking reduce maintenance overhead.","Support multiple docstring formats (Markdown, Google-style, numpydoc) across a mixed codebase without reformatting.","Publish type-annotated API docs that automatically reflect PEP 484 and PEP 526 type information from source."],"what_it_does":"pdoc3 is a command-line tool and Python library that reads your Python source code and generates formatted API documentation without requiring configuration files or special markup. It parses docstrings in Markdown, numpydoc, and Google-style formats, respects type annotations from PEP 484 and PEP 526, and automatically cross-links referenced identifiers within the documentation.\n\nThe tool is designed for minimal setup: point it at a module, package, or import path and it produces browsable HTML documentation. It includes a built-in development web server for previewing changes, supports customizable templates for advanced users, and respects Python conventions like `__all__` and docstring inheritance. It handles both module-level and instance variables by traversing abstract syntax trees.","worth_installing":"Yes, if you need straightforward API documentation for Python 3.9+ projects and accept AGPL-3.0 licensing. The low install friction, active maintenance, and zero known vulnerabilities make it reliable. The AGPL copyleft license is the main consideration: if your project or use case requires permissive licensing, this is not suitable; otherwise, it's a solid choice for minimal-configuration documentation generation."},"id":"pdoc3","links":{"html":"https://skillfed.io/packages/pdoc3","md":"https://skillfed.io/packages/pdoc3.md","pypi":"https://pypi.org/project/pdoc3/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2025-03-20","license_spdx":null,"license_treatment":"agpl","name":"pdoc3","python_support":"supports_current","summary":"Auto-generate API documentation for Python projects."},"popularity":{"monthly_downloads":290724,"position":7983,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.11.6"}