Merge pull request #51 from Botts-Innovative-Research/chore/dev-on-314 #163
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Docs2Pages | |
| on: | |
| push: | |
| branches: [main] | |
| workflow_dispatch: | |
| permissions: {} | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| concurrency: | |
| group: docs-build-${{ github.ref }} | |
| cancel-in-progress: true | |
| permissions: | |
| contents: read | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v5 | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v6 | |
| - name: Install Python 3.14 | |
| run: uv python install 3.14 | |
| - name: Install dependencies | |
| run: uv sync --all-extras | |
| - name: Build Sphinx + Furo site | |
| # `-W` promotes warnings to errors so docstring/signature drift fails CI. | |
| run: uv run sphinx-build -W --keep-going -b html docs/source docs/build/sphinx | |
| - name: Upload Pages artifact | |
| # Run on push-to-main and on manual workflow_dispatch of the main ref. | |
| # (push is already restricted to main by `on.push.branches`.) | |
| if: github.ref == 'refs/heads/main' | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: ./docs/build/sphinx | |
| deploy: | |
| needs: build | |
| # Deploy on push-to-main and on manual workflow_dispatch of the main ref. | |
| if: github.ref == 'refs/heads/main' | |
| runs-on: ubuntu-latest | |
| permissions: | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| # Per GitHub Pages guidance: don't cancel an in-flight deploy. | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: false | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |