From 72e30dc25013904958f76af81e6041b55801ece4 Mon Sep 17 00:00:00 2001 From: ekwaly <96921826+ekwaly@users.noreply.github.com> Date: Thu, 11 Jul 2024 11:37:43 +0200 Subject: [PATCH] Create documentation.yml --- .github/workflows/documentation.yml | 47 +++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 .github/workflows/documentation.yml diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 0000000..0c9a2ac --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,47 @@ +# Simple workflow for deploying static content to GitHub Pages +name: Deploy Sphinx documentation to Pages + +on: + # Runs on pushes targeting the default branch + push: + branches: [$default-branch] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Single deploy job since we're just deploying + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + container: sphinx-doc/sphinx + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Build documentation + run: | + sphinx-build -b html ./docs/ _build/ + - name: Setup Pages + uses: actions/configure-pages@v5 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + # Upload entire repository + path: '_build/' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4