Enhance documentation workflow: add changelog, update mkdocs configuration, and include pymdown-extensions in requirements

Author: grongierisc

.github/workflows/docs.yml

@@ -25,7 +25,7 @@ jobs:
         with:
           fetch-depth: 0
       - uses: actions/setup-python@v2
-      - run: pip install --upgrade pip && pip install mkdocs mkdocs-gen-files
+      - run: pip install --upgrade pip && pip install mkdocs mkdocs-gen-files pymdown-extensions
       - run: git config user.name 'github-actions[bot]' && git config user.email 'github-actions[bot]@users.noreply.github.com'
       - name: Publish docs
         run: mkdocs gh-deploy

docs/changelog.md

@@ -0,0 +1 @@
+--8<-- "CHANGELOG.md"

mkdocs.yml

@@ -20,7 +20,11 @@ nav:
     - Examples: example.md
     - Useful Links: useful-links.md
   - About:
+    - Changelog: changelog.md
     - Credits: credits.md
     - Benchmarks: benchmarks.md
 
-theme: readthedocs
+theme: readthedocs
+
+markdown_extensions:
+- pymdownx.snippets

requirements-dev.txt

@@ -7,4 +7,6 @@ wheel
 twine
 iris-embedded-python-wrapper
 jsonpath-ng
-pydantic>=2.0.0
+pydantic>=2.0.0
+mkdocs
+pymdown-extensions