Overhaul docs and fix obvious conversion issues

redis · Aug 9, 2024 · b5b2da4 · b5b2da4
1 parent 299d8e7
commit b5b2da4
Show file tree

Hide file tree

Showing 22 changed files with 2,382 additions and 2,355 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,37 @@
+name: Publish Docs
+on:
+  push:
+    branches: ["main", "markdown_docs"]
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+jobs:
+  build-and-deploy:
+    concurrency: ci-${{ github.ref }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+          cache: 'pip'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install mkdocs mkdocs-material pymdown-extensions
+      - name: Build docs
+        run: |
+          mkdocs build -d docsbuild
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: 'docsbuild'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2