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

By default, the ULHPC/tutorials repository is bound to the ulhpc-tutorials project on Read the Docs.

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 to create the site/ directory.

If you want to know more of mkdocs and readthedocs (may be for your own projects), you can check this blog post