Repository files navigation

Auto-generate API documentation for Python 3+ projects.

Project website

Documentation

$ pip install pdoc3

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

$ pdoc your_project

Seepdoc --help for more command-line switches and thedocumentationfor more usage examples.

• Simple usage. Generate sensible API (+ prose) documentation without anyspecial configuration.
• Support for commondocstrings formats (Markdown, numpydoc, Google-style docstrings),LaTeX math, and somereST directives.
• Support forPEP 484 andPEP 526 type annotations.
• pdoc respects__all__ when present.
• Docstrings for overridden class members areinherited if unspecified.
• Support for documenting module, class, and instancevariables by traversing ASTs.
• Automaticcross-linking of referenced identifiers.
• Overriding docstrings generation with special module-level__pdoc__ dictionary.
• Easily extended andcustomized templates.
• Built-indevelopment web server for near-instant preview of rendered docstrings.

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

CheckCONTRIBUTING.md for hacking details.