# Documentation

Project uses Sphinx to generate documentation from docstrings (documentation in-code) and custom pages written in Markdown (through the [MyST parser](https://myst-parser.readthedocs.io/en/latest/)).

To build it:

```bash
# build it
poetry run sphinx-build -b html -d docs/_build/cache -j auto docs docs/_build/html
```

Open `docs/_build/index.html` in a web browser.
<!-- 
# Write documentation using live render

```bash
sphinx-autobuild -b html docs/ docs/_build
```

Open <http://localhost:8000> in a web browser to see the HTML render updated when a file is saved. -->