The documentation for this puppet module is handled by Read the Docs, a web service dedicated to documentation management for the open source community.

By default, the puppet-slurm repository is bound to the ulhpc-puppet-slurm project on Read the Docs (to avoid confusion with other slurm projects).

You might wish to generate locally the docs:

  • Install mkdocs
  • Preview your documentation from the project root by running mkdocs serve and visite with your favorite browser the URL http://localhost:8000
  • build the full documentation locally by running mkdocs build