Switched to mkdocs

Author: tr11

.github/workflows/docs.yml

@@ -0,0 +1,37 @@
+name: Build Docs
+
+on:
+  release:
+    types: 
+      - published
+
+permissions:
+  contents: write
+
+env:
+  PYTHON_VERSION: 3.11
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email github-actions[bot]@users.noreply.github.com
+              
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      
+      - name: Install hatch
+        run: |
+          python -m pip install hatch
+
+      - name: Build and Publish
+        run: hatch run docs:mkdocs gh-deploy --force

.github/workflows/publish.yml

@@ -17,10 +17,10 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ env.PYTHON_VERSION }}
 

.github/workflows/run_tests.yml

@@ -19,10 +19,10 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 

.gitignore

@@ -7,6 +7,7 @@
 coverage.xml
 build/
 dist/
+site/
 .tox/
 env*/
 tmp/

docs/.gitignore

@@ -0,0 +1 @@
+../CONTRIBUTING.md

docs/CONTRIBUTING.md

@@ -0,0 +1 @@
+../CHANGELOG.md

docs/Makefile

@@ -0,0 +1 @@
+../README.md