pdoc
Automatically generate API documentation for Python projects from existing docstrings. Supports type hints, cross-linking, and common docstring formats.
pdoc is a straightforward tool for automatically generating API documentation for Python projects directly from your existing code and docstrings. It requires zero configuration to get started. Key features include:
- First-class support for type annotations: Understands modern Python typing.
- Automatic cross-linking: Creates links between related identifiers in your documentation.
- Integrated web server: Includes a live-reloading web server for easy previewing.
- Docstring format support: Works with plain, numpydoc, or Google-style docstrings.
It respects your project's module hierarchy to produce organized documentation. Just run pdoc your_module and it generates HTML documentation.
Categories:
Tags:
Starlight
WretchSimilar to pdoc:
Query databases naturally with Python generators.
ORMsPython
Write database queries using Python generator expressions. Translates Python syntax trees to SQL for SQLite, MySQL, PostgreSQL, and Oracle. Features an ERD editor.
Visual Python debugging, right in your terminal.
DebuggingPython
Debug Python code visually within your console. Offers a lightweight, keyboard-driven interface with syntax highlighting, stack traces, and variable inspection.
Profile live Python code safely, with minimal overhead.
DebuggingProfiling+1 more
Profile running Python programs with extremely low overhead. Visualize time spent without restarting or modifying code. Safe for production environments.
Database abstraction without the ORM overhead.
ORMsPython
Write database-agnostic Python code. This pure Python DAL dynamically generates SQL/NoSQL, mapping records to dictionaries for simpler data access.
Flexible toolkit for Python code tracing and debugging.
DebuggingPython
Trace Python code execution with powerful filters and custom actions. Debug, log, and inspect code behavior without complex setup or storage.
Async database access for Python with validation.
ORMsPython
An async Python ORM supporting Postgres, MySQL, and SQLite. Built with SQLAlchemy core, Databases, and Pydantic for validation and migrations.
Create intelligent, beautiful, and linked documentation.
DocumentationPython
Generate versatile, cross-referenced technical documentation from reStructuredText or Markdown. Supports multiple output formats, themes, extensions, and API docs.
Pythonic SQL toolkit and ORM for flexible database access.
ORMsPython
Access databases in Python with a powerful SQL toolkit and Object Relational Mapper. Gain full SQL flexibility and high-performance persistence patterns.
Build stellar documentation sites, fast.
Astro (JS)Documentation
Build fast, accessible, and feature-rich documentation websites with Astro. Includes navigation, search, i18n, SEO, code highlighting, and dark mode.