documentation

[orbeckst]

Currently (since PR #2) we build documentation from docs/ with sphinx (make html). We have a workflow to publish the docs on GH pages branch. However, these docs would be public even though the repo is private. Do we want that?

[orbeckst]

You can manually build docs with (have "sphinx myst-parser>=2.0 furo>=2024.1.0 sphinx-copybutton>=0.5" installed)

cd docs
make html

and open docs/_build/html/index.html.