diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 0000000..a1b4089 --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,56 @@ +name: GH Pages Sphinx Docs +on: [push, pull_request] + +# 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: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout repo + uses: actions/checkout@v3 + + - name: Setup Pages + uses: actions/configure-pages@v3 + + - name: Install Python + uses: actions/setup-python@v5 + with: + python-version: "3.12" + cache: "pip" + + - name: Install swmmio + run: | + pip install -r requirements.txt -r docs/requirements.txt + pip install -e . + + - name: Sphinx build + run: sphinx-build docs/source docs/build + + - name: Upload artifact + uses: actions/upload-pages-artifact@v2 + with: + # Upload build + path: './docs/build' + + deploy: + if: startsWith(github.event.ref, 'refs/tags/v') + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2