Update docs

Author: deathaxe

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

@@ -0,0 +1,27 @@
+name: Deploy Docs to Github Pages
+
+on:
+  push:
+    branches:
+      - 'master'
+    paths:
+      - 'docs/**'
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Deploy Docs to Github Pages
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.8'
+      - name: Install MkDocs
+        run: pip install -r docs/requirements.txt
+      - name: Run MkDocs
+        run: mkdocs gh-deploy

.gitignore

@@ -2,6 +2,7 @@
 .cache/
 .mypy_cache/
 .ropeproject/
+.venv/
 __pycache__/
 site/
 var/

docs/requirements.txt

@@ -0,0 +1,5 @@
+mkdocs
+mkdocs-material
+mkdocs-git-revision-date-localized-plugin
+mkdocs-minify-plugin
+pymdown-extensions

mkdocs.yml

@@ -22,8 +22,10 @@ theme:
   palette:
     primary: indigo
     accent: red
-  logo:
-    icon: description
+
+plugins:
+  - minify:
+      minify_html: true
 
 markdown_extensions:
   - markdown.extensions.admonition:
@@ -34,7 +36,7 @@ markdown_extensions:
   - markdown.extensions.def_list:
   - markdown.extensions.tables:
   - markdown.extensions.abbr:
-  - pymdownx.extrarawhtml:
+  # - pymdownx.extrarawhtml:
   - pymdownx.superfences:
   - pymdownx.highlight:
       css_class: codehilite