pydoc-pipeline

What problem does it solve?

Remove the tedious manual work of writing API documentation and docstrings by automatically extracting public APIs from Python code and producing ready-to-use Markdown docs and examples.

Core Features & Use Cases

• Scans a repository with Python's AST to inventory modules, public classes, functions, and constructor signatures.
• Generates Google-style docstrings for missing public items, classifies self-documenting or intentionally undocumented code, and optionally writes docstrings back to source files.
• Builds a docs/ directory with three markdown files: a package overview (README), a complete API reference organized by module, and runnable usage examples; ideal for handoffs, releases, and onboarding new maintainers.
• Use case: convert a library lacking documentation into a developer-facing docs/ folder and add concise docstrings for newly added public APIs.

Quick Start

Generate documentation for the current Python package, adding Google-style docstrings to missing public symbols and creating docs/README.md, docs/api-reference.md, and docs/examples.md.