From dbf69d81cb72b79da85c757bd50c9d622e043c24 Mon Sep 17 00:00:00 2001
From: Nicolas Vuillamy <nicolas.vuillamy@gmail.com>
Date: Sun, 19 Nov 2023 23:03:24 +0100
Subject: [PATCH] Fix mkdocs generation + CI control job (#3135)

* Use mkdocs-material emojis extension

* Fix mkdocs-material generation + control job
---
 .github/workflows/build-deploy-docs.yml |  2 +-
 .github/workflows/deploy-RELEASE.yml    |  2 +-
 .github/workflows/test-mkdocs.yml       | 28 +++++++++++++++++++++++++
 mkdocs.yml                              |  6 +++---
 4 files changed, 33 insertions(+), 5 deletions(-)
 create mode 100644 .github/workflows/test-mkdocs.yml

diff --git a/.github/workflows/build-deploy-docs.yml b/.github/workflows/build-deploy-docs.yml
index cd17508b16f..b1ed83271d2 100644
--- a/.github/workflows/build-deploy-docs.yml
+++ b/.github/workflows/build-deploy-docs.yml
@@ -28,7 +28,7 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-python@v4.5.0
         with:
-          python-version: 3.10.4
+          python-version: 3.12.0
       - run: pip install --upgrade -r .config/python/dev/requirements.txt
       - run: cd .automation && bash build_schemas_doc.sh && cd ..
       # - run: mkdocs gh-deploy --force
diff --git a/.github/workflows/deploy-RELEASE.yml b/.github/workflows/deploy-RELEASE.yml
index 83702d27bab..f361c14b9ef 100644
--- a/.github/workflows/deploy-RELEASE.yml
+++ b/.github/workflows/deploy-RELEASE.yml
@@ -154,7 +154,7 @@ jobs:
           echo "curr ver ${{ steps.version.outputs.cversion }}"
       - uses: actions/setup-python@v4.5.0
         with:
-          python-version: 3.x
+          python-version: 3.12.0
       - run: pip install --upgrade -r .config/python/dev/requirements.txt
       - run: cd .automation && bash build_schemas_doc.sh && cd ..
       # - run: mkdocs gh-deploy --force
diff --git a/.github/workflows/test-mkdocs.yml b/.github/workflows/test-mkdocs.yml
new file mode 100644
index 00000000000..1479c78d821
--- /dev/null
+++ b/.github/workflows/test-mkdocs.yml
@@ -0,0 +1,28 @@
+name: "Check MkDocs generation"
+on:
+  push:
+    paths:
+      - "**/mkdocs.yml"
+  pull_request:
+    paths:
+      - "**/mkdocs.yml"
+
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+
+  test-doc-gen:
+    runs-on: ubuntu-latest
+    permissions: read-all
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4.5.0
+        with:
+          python-version: 3.12.0
+      - run: pip install --upgrade -r .config/python/dev/requirements.txt
+      - run: cd .automation && bash build_schemas_doc.sh && cd ..
+      - run: mkdocs build
+
+ 
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index 697f718de72..1140b5a70cf 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -25,12 +25,12 @@ plugins:
   - search
 markdown_extensions:
   - pymdownx.emoji:
-      emoji_index: !!python/name:materialx.emoji.twemoji
-      emoji_generator: !!python/name:materialx.emoji.to_svg
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - pymdownx.snippets:
       base_path: docs
       check_paths: true
-      restrict_base_path: False
+      restrict_base_path: false
   - mdx_truly_sane_lists
   - attr_list
 extra_javascript: