Project description

pdoc

Auto-generate API documentation for Python projects.

$ 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 type annotations.
pdoc respects __all__ when present.
Inheritance used as applicable for inferring docstrings for class members.
Support for documenting module, class, and instance variables by traversing ASTs.
Automatic cross-linking of referenced identifiers in HTML and PDF.
Overriding docstrings with special module-level __pdoc__ dictionary.
Built-in development web server for near-instant preview of rendered docstrings.

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

Algorithm	Hash digest
SHA256	`df43a7f1a139a5a61e778f424f167719acc33ed71bf13b6c34c7ebd139866eb7`
MD5	`2d430e505d8a6377dbb82a5b701c8312`
BLAKE2b-256	`9bbcb1c36f5cb715da54b5a690050a3099480fa7be19e09d51d4f4c0594e74b0`