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.
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).

Name	Latest commit message	Commit time
Failed to load latest commit information.
.github	MNT: Lint markdown files	May 2, 2019
doc	MNT: docs/build: Update deprecated CLI params	May 2, 2019
example
pdoc	Merge pull request pdoc3#62 from kernc/new_import	May 3, 2019
.codecov.yml	Disable codecov comments	Jun 3, 2018
.coveragerc	MNT: add .coveragerc and increase reported coverage of CLI module	Dec 29, 2018
.gitignore	ENH: Configurable highlight style (pdoc3#38 )	Feb 25, 2019
.travis.yml	MNT: Lint markdown files	May 2, 2019
CHANGELOG	MNT: Update changelog for 0.6.0	May 3, 2019
CONTRIBUTING.md	DOC: CONTRIBUTING.md: Expand Pull requests section	Jan 31, 2019
LICENSE.txt
MANIFEST.in	MNT: Add MANIFEST.in	Jan 7, 2019
README.md
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