From 53984a059f43f004e2877d9363f0ae849375a2ee Mon Sep 17 00:00:00 2001
From: Matthias <xmatthias@outlook.com>
Date: Fri, 9 Oct 2020 09:02:20 +0200
Subject: [PATCH] Configure mkdocs to allow page includes

---
 .github/workflows/ci.yml   | 5 +++++
 docs/developer.md          | 2 +-
 docs/requirements-docs.txt | 1 +
 mkdocs.yml                 | 8 ++++----
 4 files changed, 11 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 5dad1443b..a89254349 100644
--- a/.github/workflows/ci.yml
+++ b/.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)
diff --git a/docs/developer.md b/docs/developer.md
index 788e961cd..8ef816d5d 100644
--- a/docs/developer.md
+++ b/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.
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
index 66225d6d4..69ae33649 100644
--- a/docs/requirements-docs.txt
+++ b/docs/requirements-docs.txt
@@ -1,2 +1,3 @@
 mkdocs-material==6.0.2
 mdx_truly_sane_lists==1.2
+pymdown-extensions==8.0.1
diff --git a/mkdocs.yml b/mkdocs.yml
index 26494ae45..8d1ce1cfe 100644
--- a/mkdocs.yml
+++ b/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