pdoc Quick Reference

Authors
Kevin T. Chu <[email protected]>

pdoc is a simple CLI tool that generates API documentation from Python source code (docstrings).

This project is configured to support auto-generation of API documentation for Python code in the src directory, but pdoc can be used directly to generate documentation for Python modules and packages in any location.

Generating API Documentation

Using the project `make` rules

Generate documentation for Python code in the src directory.
```
$ make docs
```
Documentation is generated in HTML format and written to the docs/api directory.

Using `pdoc`

Generate HTML-formatted documentation for a Python package or module.
```
$ pdoc --html MODULE -o DOC_DIR
```
Notes
- MODULE can be (1) a path to a file or directory or (2) the name of an importable Python package or module.
- Documentation written to the DOC_DIR directory.