From 7e955e227904be3aa5fd52db79939291c57f20ac Mon Sep 17 00:00:00 2001 From: Setu Pelz Date: Mon, 3 Aug 2026 15:55:35 +0200 Subject: [PATCH] ci: deploy docs to GitHub Pages on push --- .github/workflows/docs.yml | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 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..0e383a5 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,30 @@ +# Build the docs and publish them to GitHub Pages (gh-pages branch) +# on every docs-relevant push to main. Manual runs: Actions tab or +# `gh workflow run docs.yml`. +name: docs + +on: + push: + branches: [main] + paths: + - "docs/**" + - "mkdocs.yml" + - "src/**" + - "README.md" + workflow_dispatch: + +permissions: + contents: write + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: astral-sh/setup-uv@v5 + with: + python-version: "3.12" + - name: Install + run: uv sync --locked + - name: Build and publish + run: uv run mkdocs gh-deploy --force