Getting started

Based on Material for MkDocs

https://squidfunk.github.io/mkdocs-material/getting-started/

Install Hatch

Hatch is a tool for managing Python projects.

pip install hatch

Run the development server

Run the following command to get a server that will automatically update the docs pages whenever you edit the sources.

hatch run mkdocs serve

Build the static site

Run the following command to build the static site. The result will be in the site directory.

hatch run mkdocs build

Run test suites

This project uses mktestdocs to check the validity of python code samples. Code prefixed with python will be tested while code prefixed with py is not supposed to be a valid code (example: function signatures).

hatch run testing:test