Skip to content

Start Gmsh cookbook

Max Orok requested to merge cookbook into master

Here is the start of a Gmsh "cookbook", for small self-contained examples that aren't big enough for a dedicated tutorial, but still might be useful for people learning how to use the Gmsh API.

I am not super experienced with gitlab, so there might be some hitches getting started. I tried to use the special pages target and followed notes from:

Gitlab apparently publishes files in the public directory to "https://username.gitlab.io/projectname" for a given user and project, but I don't know if that's the case for this custom site.

I am using mdbook, and a docker image maintained by the mdbook developer Michael Bryan. This image supports link-checking at build time. It will only build on master, but thinking again, it might be better to build and test on each change (but only deploy on master).

There are no automated tests for the book yet, but since there are standalone code files for each example, we should be able to set up tests as if these were tutorial scripts (see doc/cookbook/geometry/split-curve.py, etc). I put building the cookbook in the .post stage, because I didn't want to block builds without asking first, but it could better instead to check that all the examples build before pushing.

Please let me know if you want changes to the layout, the CI setup, or anything else.

Merge request reports