Documentation

Ordeq uses MkDocs for documentation, and mkdocstrings for auto-generating the API documentation. The documentation is configured in mkdocs.yml at the root of the repository.

To view the documentation locally, first install all dependencies:

just install

To spin up the documentation server, run:

just docs-serve

Now navigate to http://127.0.0.1:8000/ and enjoy the documentation!