pdoc

Auto-generate API documentation for Python 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) and some reST directives.
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.
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).

Name	Latest commit message	Commit time
Failed to load latest commit information.
.github	MNT: Add sitemap.txt generation for gh-pages	Jan 12, 2019
doc	MNT: doc/build should recommend pdoc3	Jan 12, 2019
pdoc	Config: Change defaults for inherited members and class vars	Jan 10, 2019
.codecov.yml	Disable codecov comments	Jun 3, 2018
.coveragerc	MNT: add .coveragerc and increase reported coverage of CLI module	Dec 29, 2018
.gitignore	MNT: Update .gitignore	Jan 9, 2019
.travis.yml	REF: Add some more type annotations and check with mypy	Jan 10, 2019
CHANGELOG	Update CHANGELOG	Jan 7, 2019
CONTRIBUTING.md	MNT: Add CONTRIBUTING.md	Jan 7, 2019
LICENSE.txt	Relicense as AGPL-3.0+	Nov 28, 2018
MANIFEST.in	MNT: Add MANIFEST.in	Jan 7, 2019
README.md	DOC: Update README.md	Jan 18, 2019
setup.cfg	REF: Add some more type annotations and check with mypy	Jan 10, 2019
setup.py	MNT: Bump Markdown to 3.0+ for smarty.smart_angled_quotes setting	Jan 12, 2019