From 8ccdea371f0c15af614b2ee79c9512d70914a765 Mon Sep 17 00:00:00 2001 From: sehkone Date: Sat, 17 Jan 2026 11:07:25 +0900 Subject: [PATCH] Add GitHub Pages docs deployment workflow - Build MkDocs docs on main and upload the Pages artifact. - Deploy the published site via GitHub Pages Actions Closes #132 --- .github/workflows/docs.yml | 50 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..7c36289 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,50 @@ +name: Docs + +on: + push: + branches: + - main + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: pages + cancel-in-progress: true + +jobs: + build: + name: Build Docs + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v6 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install MkDocs + run: python3 -m pip install --upgrade pip mkdocs-material mkdocs-static-i18n + + - name: Build + run: mkdocs build --strict + + - name: Upload Pages Artifact + uses: actions/upload-pages-artifact@v3 + with: + path: site + + deploy: + name: Deploy Docs + needs: build + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4