From 4869d0dab894b5fe07b5878558b337ef2e50fdaf Mon Sep 17 00:00:00 2001 From: Matthias Mair Date: Mon, 5 Feb 2024 10:40:38 +0000 Subject: [PATCH] Add mermaid to docs (#5405) * move devcontainer docs * rename bare metal pages * fix backlinks * Add getting started for devs * add mermaid * include contrib in docs * use another plugin * include everything * update doc checks * fix install command * Update mkdocs.yml * Update mkdocs.yml * Update starting.md * Update starting.md * Update starting.md * extend requirements * Update mkdocs.yml * clean diff * clean diff + check if it works * fix CI check for custom tags * clean md --- .github/workflows/qc_checks.yaml | 1 + docs/ci/check_mkdocs_config.py | 4 ++-- docs/mkdocs.yml | 6 +++++- docs/requirements.txt | 2 +- 4 files changed, 9 insertions(+), 4 deletions(-) diff --git a/.github/workflows/qc_checks.yaml b/.github/workflows/qc_checks.yaml index 8a3e1d609b..70592c6817 100644 --- a/.github/workflows/qc_checks.yaml +++ b/.github/workflows/qc_checks.yaml @@ -105,6 +105,7 @@ jobs: - name: Check Config run: | pip install pyyaml + pip install -r docs/requirements.txt python docs/ci/check_mkdocs_config.py - name: Check Links run: | diff --git a/docs/ci/check_mkdocs_config.py b/docs/ci/check_mkdocs_config.py index a5e0c9e353..93a3afe0c8 100644 --- a/docs/ci/check_mkdocs_config.py +++ b/docs/ci/check_mkdocs_config.py @@ -11,6 +11,6 @@ tld = os.path.abspath(os.path.join(here, '..')) config_file = os.path.join(tld, 'mkdocs.yml') with open(config_file, 'r') as f: - data = yaml.safe_load(f) + data = yaml.load(f, yaml.BaseLoader) - assert data['strict'] is True + assert data['strict'] == 'true' diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 2afbf527ae..2e08051e25 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -240,7 +240,11 @@ markdown_extensions: - meta - pymdownx.details - pymdownx.highlight - - pymdownx.superfences + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format # - pymdownx.emoji: # emoji_index: !!python/name:materialx.emoji.twemoji # emoji_generator: !!python/name:materialx.emoji.to_svg diff --git a/docs/requirements.txt b/docs/requirements.txt index 2bfb42c832..7058fca4a0 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -mkdocs==1.4.3 +mkdocs==1.5.3 mkdocs-macros-plugin>=0.7,<1.0 mkdocs-material>=9.0,<10.0 mkdocs-git-revision-date-localized-plugin>=1.1,<2.0