Configure mkdocs to allow page includes

.github/workflows/ci.yml

@@ -184,6 +184,11 @@ jobs:
       run: |
         ./tests/test_docs.sh
 
+    - name: Documentation build
+      run: |
+        pip install -r docs/requirements-docs.txt
+        mkdocs build
+
     - name: Slack Notification
       uses: homoluctus/slatify@v1.8.0
       if: failure() && ( github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false)

docs/developer.md

@@ -96,7 +96,7 @@ Below is an outline of exception inheritance hierarchy:
 
 ## Modules
 
-### Dynamic Pairlist
+### Pairlists
 
 You have a great idea for a new pair selection algorithm you would like to try out? Great.
 Hopefully you also want to contribute this back upstream.

docs/requirements-docs.txt

@@ -1,2 +1,3 @@
 mkdocs-material==6.0.2
 mdx_truly_sane_lists==1.2
+pymdown-extensions==8.0.1

mkdocs.yml

@@ -55,16 +55,16 @@ markdown_extensions:
         permalink: true
     - pymdownx.arithmatex:
         generic: true
-    - pymdownx.caret
-    - pymdownx.critic
     - pymdownx.details
     - pymdownx.inlinehilite
     - pymdownx.magiclink
-    - pymdownx.mark
+    - pymdownx.pathconverter
     - pymdownx.smartsymbols
+    - pymdownx.snippets:
+        base_path: docs
+        check_paths: true
     - pymdownx.tabbed
     - pymdownx.superfences
     - pymdownx.tasklist:
         custom_checkbox: true
-    - pymdownx.tilde
     - mdx_truly_sane_lists