Re-work Docs and split out README (using MkDocs)

.github/workflows/documentation.yml

@@ -0,0 +1,26 @@
+name: Docs
+
+on:
+ push:
+ branches: [ stable ]
+ paths:
+ - 'docs/**'
+ - 'mkdocs.yml'
+ - '.github/workflows/documentation.yml'
+
+ # Allows you to run this workflow manually from the Actions tab
+ workflow_dispatch:
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v2
+ with:
+ fetch-depth: 0
+ - uses: actions/setup-python@v2
+ - run: pip install --upgrade pip && pip install mkdocs mkdocs-gen-files
+ - 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

.gitignore

@@ -94,6 +94,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+site/
 
 # PyBuilder
 target/