Deltares / iMOD-Documentation

📚 Documentation of the iMOD suite.

iMOD Suite Documentation

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.

Local Build

1. Install Quarto and pixi
2. git clone https://github.com/Deltares/iMOD-Documentation.git
3. cd iMOD-Documentation
4. pixi run install-pre-commit
5. pixi run docs
6. To render PDF (deleting any previously build documentation): quarto render docs --profile manual --to pdf

Project setup

The Quarto project is set up using different profiles, specified in the _quarto-<profile>.yml files. These are:

• website: The website, render as html
• manual: The full user manual, render as pdf
• install: The installation guide, render as pdf. Can be shipped with the release.
• tutorial: The tutorial pages, render as pdf. Can be used during trainings.