Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 723 Bytes

File metadata and controls

38 lines (25 loc) · 723 Bytes

docc

documentation badge

The documentation compiler.

Python Quickstart

Installing

pip install docc

Configuring

Add the following to your pyproject.toml:

[tool.docc.plugins."docc.python.discover"]
paths = [ "<path to Python source>" ]

[tool.docc.output]
path = "<where to put rendered documentation>"

Building

Finally, to generate the documentation:

docc