Fix docs build with python 3.12 and pin the python version in the gh workflows. (#95)

* Fix markdown, maybe?

* Upgrade mkdocs and mkdocs-material.

* Update mkdocs plugins.

* Pin the python version.

* Add sanity check to ensure the page isn't completely screwed up.

Author: leMaik

.github/workflows/gh-pages-deploy.yaml

@@ -10,7 +10,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
         with:
-          python-version: 3.x
+          python-version: 3.12
       - name: Setup Python
         run: |
           python -m venv ./venv --clear
@@ -20,6 +20,7 @@ jobs:
         run: |
           source ./venv/bin/activate
           ./build.sh
+          test -f ./docs/index.html # sanity check
       - name: Deploy to GH Pages
         run: |
           pip install ghp-import

.github/workflows/pr-build.yaml

@@ -19,7 +19,7 @@ jobs:
       - name: Install Python
         uses: actions/setup-python@v2
         with:
-          python-version: 3.x
+          python-version: 3.12
 
       - name: Setup Python
         run: |
@@ -30,7 +30,8 @@ jobs:
       - name: Build docs
         run: |
           source ./venv/bin/activate
-          bash ./build.sh
+          ./build.sh
+          test -f ./docs/index.html # sanity check
 
       - name: Save PR Number
         run: echo ${{ github.event.number }} > ./docs/pr-number.txt

ChunkyDocs/mkdocs.yml

@@ -101,8 +101,8 @@ markdown_extensions:
   - footnotes
   - attr_list
   - 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.highlight
   - pymdownx.inlinehilite
   - pymdownx.superfences

requirements.txt

@@ -5,16 +5,16 @@ Jinja2==3.0.2
 joblib==1.0.1
 livereload==2.6.3
 lunr==0.5.8
-Markdown==3.3.4
-MarkupSafe==2.0.0
-mkdocs==1.4.2
-mkdocs-macros-plugin==0.7.0
-mkdocs-material==9.0.10
+Markdown==3.3.7
+MarkupSafe==2.1.3
+mkdocs==1.5.3
+mkdocs-macros-plugin==1.0.4
+mkdocs-material==9.4.7
 nltk==3.6.2
 PyYAML==5.3.1
 regex==2022.4.24
 six==1.16.0
 tornado==6.1
 tqdm==4.60.0
-mkdocs-redirects==1.2.0
+mkdocs-redirects==1.2.1
 mkdocs-simple-hooks==0.1.5