Quickstart

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

The theme requires a few Python libraries to build. These are easily install with conda.

1. Install Sphinx Python build environment.

   conda env create -f Docs/environment.yaml
   

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

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

   conda activate sphinx
   cd Docs
   make html