Skip to content

Commit

Permalink
Include demo graph from g-adopt repository
Browse files Browse the repository at this point in the history
This is a mermaid.js diagram that we include as a snippet, allowing
for more dynamic configuration of the relationship between demos.
  • Loading branch information
angus-g committed Jun 12, 2024
1 parent 843b083 commit d969d77
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 2 deletions.
1 change: 1 addition & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ jobs:
rm -rf rendered && mkdir rendered
find tutorials/demos -name '*.ipynb' -exec cp "{}" rendered \;
cp tutorials/demos/.pages rendered
cp tutorials/demos/.diagram.mermaid rendered
env:
GADOPT_LOGLEVEL: WARN
- uses: actions/upload-artifact@v4
Expand Down
4 changes: 3 additions & 1 deletion docs/tutorials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ The diagram below shows several G-ADOPT example codes and how they
relate to each other. These notebooks demonstrate how to use G-ADOPT
to set up (forward and inverse) geodynamical simulations.

INCLUDE IMAGE HERE.
```mermaid
--8<-- "docs/tutorials/.diagram.mermaid"
```

We start with the most basic problem - isoviscous, incompressible
convection, in an enclosed 2-D Cartesian box (base) - and
Expand Down
6 changes: 5 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,11 @@ markdown_extensions:
- md_in_html
- pymdownx.details
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- toc:
toc_depth: 3
extra_css:
Expand Down

0 comments on commit d969d77

Please sign in to comment.