2024/09/23 release

Signed-off-by: Shield of Self-Defense (ocf.tw) <[email protected]>

.github/workflows/build_docs.yml

@@ -0,0 +1,45 @@
+name: Build Docs
+on:
+  push:
+    branches:
+      - shield
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name ocf-ssd[bot]
+          git config user.email [email protected]
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Cache Poetry venv
+        uses: actions/cache@v4
+        with:
+          path: ./.venv
+          key: poetry-venv-${{ hashFiles('**/poetry.lock') }}
+      - name: Cache Poetry local
+        uses: actions/cache@v4
+        with:
+          path: ~/.local/share/pypoetry
+          key: poetry-local-${{ hashFiles('**/poetry.lock') }}
+      - name: Cache Poetry cache
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pypoetry
+          key: poetry-cache-${{ hashFiles('**/poetry.lock') }}
+      - name: Install and configure Poetry
+        uses: snok/install-poetry@v1
+        with:
+          version: 1.8.3
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+          installer-parallel: true
+      - name: Install dependencies
+        run: poetry install
+      - name: Build Docs
+        run: poetry run mkdocs gh-deploy --force

.gitignore

@@ -0,0 +1,2 @@
+/site
+.cache

.vscode/settings.json

@@ -0,0 +1,13 @@
+{
+    "yaml.schemas": {
+      "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
+    },
+    "yaml.customTags": [ 
+      "!ENV scalar",
+      "!ENV sequence",
+      "!relative scalar",
+      "tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
+      "tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
+      "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
+    ]
+  }