Skip to content

Latest commit

 

History

History
45 lines (39 loc) · 1.08 KB

File metadata and controls

45 lines (39 loc) · 1.08 KB

Documentation… documentation!

Dependencies

First install the dependencies:

$ python3 -m pip install -r requirements_docs.txt

(or uv pip install …)

Build

$ sphinx-build -M html docs out

Serve

You can use any static file HTTP server, e.g.:

$ python3 -m http.server -d 'out/html'

Build & server (watch for changes)

$ python3 -m pip install sphinx-autobuild
$ sphinx-autobuild docs out

Release to readthedocs

See GitHub Action