Jupyter notebooks in
Tests/Data are automatically executed and converted to web pages in the benchmark documentation section.
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 = "Notebooks/SimplePETSc.ipynb" [menu] [menu.benchmarks] parent = "elliptic" <!--eofm-->
Do not use HTML inside Markdown blocks.
For image captions add a title in quotation marks after the image path, e.g.
![Alt text](./my_image.png "This will be the image caption.")
Please note that in merge request web previews images are not shown at all.