From 1391158dde2ff75db6644ba0f4746f3d77b7b5c1 Mon Sep 17 00:00:00 2001 From: Tony Wood <69479110+woodtp@users.noreply.github.com> Date: Mon, 12 Jan 2026 11:35:25 -0500 Subject: [PATCH] Create docs.yml New workflow to automatically build documentation and deploy to Pages. --- .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 00000000..ce5f24dc --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,50 @@ +# Simple workflow for deploying static content to GitHub Pages +name: Deploy Documentation to Pages + +on: + # Runs on pushes targeting the default branch + push: + branches: ["main"] + + # 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 + steps: + - name: Checkout + uses: actions/checkout@v4 + - uses: conda-incubator/setup-miniconda@v2 + with: + activate-environment: po3 + environment-file: docs-environment.yml + - uses: ammaraskar/sphinx-action@master + with: + docs-folder: "doc/" + # - name: Setup Pages + # uses: actions/configure-pages@v5 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + # Upload entire repository + path: './doc/build/html' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4