What prettydocs scanned
A lightweight map of your package, focused on structure and public APIs.
Start here
A quick path from source code to a browsable site.
Generate the site
python -m prettydocs path/to/package/**/*.py --out ./prettydocs-site
Open index.html in the output folder.
Explore the docs
Navigate the main views generated by prettydocs.
Understand the structure
Module tree, hotspots, and dependency map.
OpenBrowse modules and functions
Definitions, docstrings, and entry points.
OpenLearn the terminology
Signals, hotspots, dependency maps, and more.
OpenUser documentation
Markdown files you provide alongside the package.
Open guidesJump into the API
Direct links into the browsable API surface.
Module index
Start with the package map and module details.
Browse modulesClass definitions
Open class summaries and definitions.
Browse classesFunction definitions
Inspect public functions and signatures.
Browse functionsDeclared dependencies
From pyproject.toml.