Sopa documentation

The documentation is generated by Mkdocs material and deployed when pushing a new tag on GitHub.

Serve locally

Clone the repository and install all the dependencies:

poetry install --all-extras

Then, run:

mkdocs serve

You can also update the CLI docs (if you install typer-cli) with the following command line:

typer sopa.main utils docs --output tmpfile --name sopa && sed '1,2d; s/## /### /g; s/Usage:/!!! note '\"'Usage'\"'/g' tmpfile >> docs/cli.md && rm tmpfile