Quickstart

Quickstart#

All documenation files are placed in the Docs/ subfolder. They can be moved if another directory structure if needed.

The template uses Pixi as a package manager. See the pixi.toml file for available commands.

  1. Customize the Docs/conf.py file to adapt project as needed. (delete quickstart.md and customize/).

  2. To build the sphinx documenation’s HTML pages run the following: 🎉

    pixi run html

  3. To build the PDF version run:

    pixi run pdf