From 9a87e5ba313c00d8a826979dd411ea34f7b45717 Mon Sep 17 00:00:00 2001 From: Sidhant185 <74181527+Sidhant185@users.noreply.github.com> Date: Fri, 20 Mar 2026 12:50:29 +0530 Subject: [PATCH] ci: add GitHub Actions workflow to build and deploy MkDocs documentation --- .github/workflows/docs.yml | 39 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 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 000000000..820e68301 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,39 @@ +name: Deploy Documentation + +on: + push: + branches: + - main + pull_request: + branches: + - main + +permissions: + contents: write + +jobs: + build-and-deploy-docs: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.10" + + - name: Install uv + uses: astral-sh/setup-uv@v3 + + - name: Install dependencies + run: uv sync --group docs + + - name: Build documentation + run: uv run mkdocs build --strict + + - name: Deploy to GitHub Pages + if: github.event_name == 'push' && github.ref == 'refs/heads/main' + run: uv run mkdocs gh-deploy --force