pdoc

Auto-generate API documentation for Python 3+ projects.

Installation

$ pip install pdoc3

Pdoc will accept a Python module file, package directory or an import path.

$ pdoc your_project

See pdoc --help for more command-line switches and the documentation
for more usage examples.

Simple usage. Generate sensible API (+ prose) documentation without any
special configuration.
Support for common docstrings formats (Markdown, numpydoc, Google-style docstrings),
LaTeX math, and some reST directives.
Support for PEP 484 and PEP 526 type annotations.
pdoc respects __all__ when present.
Docstrings for overridden class members are inherited if unspecified.
Support for documenting module, class, and instance variables by traversing ASTs.
Automatic cross-linking of referenced identifiers.
Overriding docstrings generation with special module-level __pdoc__ dictionary.
Easily extended and customized templates.
Built-in development web server for near-instant preview of rendered docstrings.

The above features are explained in more detail in pdoc's documentation
(generated with pdoc).

Check CONTRIBUTING.md for hacking details.

Dependencies of pdoc3 (2).
Dependency	Optional
mako	false
markdown	false