Jupyter notebooks can be placed in
Tests/Data along regular benchmarks. See Notebook testing for details on how to setup ogs execution (especially input data path handling) inside the notebook. See also the SimpleMechanics.ipynb-notebook as an example.
Similar to regular web documentation pages the notebook requires to have a frontmatter with some meta information as the first cell in the notebook:
Add a new cell and move it to the first position in the notebook
Change the cell type to
Add meta information, conclude with a end-of-file marker (
title = "SimplePETSc" date = "2021-11-09" author = "Lars Bilke" notebook = "Mechanics/Linear/SimpleMechanics.ipynb" image = "optional_gallery_image.png" web_subsection = "small-deformations" <!--eofm-->
Static images e.g. for the gallery image or to be used in Markdown cells have to located in either
figures-subdirectories beneath the Notebook file! Otherwise they will not show up in the web site.
Do not use HTML inside Markdown blocks.
For image captions add a title in quotation marks after the image path, e.g.
![Alt text](figures/my_image.png "This will be the image caption.")
Please note that in merge request web previews images are not shown at all.