diff --git a/.github/workflows/docs-deploy-to-gh-pages.yml b/.github/workflows/docs-deploy-to-gh-pages.yml new file mode 100644 index 00000000..7197617b --- /dev/null +++ b/.github/workflows/docs-deploy-to-gh-pages.yml @@ -0,0 +1,56 @@ +# Based on the GitHub example deployment workflow for static pages +name: Build and Deploy Static HTML Docs to GitHub Pages + +on: + # Runs on pushes targeting the default branch + push: + branches: ["master"] + + # 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: + docs-to-gh-pages: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: '3.12' + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r docs/requirements.txt + + - name: Build Sphinx documentation + run: | + make -C docs html + - uses: actions/configure-pages@v5 + - uses: actions/upload-pages-artifact@v3 + with: + path: docs/build/html + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 \ No newline at end of file