The iMOD Suite documentation is generated here.
The documentation is set up using Quarto. Read here how to get started using Quarto.
If you want to contribute to the iMOD Suite documentation, please read the contributing guidelines.
- Install Quarto and pixi
git clone https://github.com/Deltares/iMOD-Documentation.git
cd iMOD-Documentation
pixi run install-pre-commit
pixi run docs
- To render PDF (deleting any previously build documentation):
quarto render docs --profile manual --to pdf
The Quarto project is set up using different profiles, specified in the
_quarto-<profile>.yml
files. These are:
website
: The website, render as htmlmanual
: The full user manual, render as pdfinstall
: The installation guide, render as pdf. Can be shipped with the release.tutorial
: The tutorial pages, render as pdf. Can be used during trainings.