Refactor archive creation code (#92) #135
This file contains 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: "Sphinx: Publish docs" | |
| on: | |
| pull_request: | |
| branches: | |
| - "**" | |
| paths: | |
| # Only run for changes to this workflow file | |
| # (docs-preview workflow covers actual docs changes) | |
| - ".github/workflows/docs.yml" | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| build: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| # Not actually a matrix build, but defined as one for consistency | |
| max-parallel: 1 | |
| matrix: | |
| python-version: [3.12] | |
| os: [ubuntu-latest] | |
| permissions: | |
| # Allow updating the gh-pages branch | |
| contents: write | |
| # Check https://github.com/actions/action-versions/tree/main/config/actions | |
| # for latest versions if the standard actions start emitting warnings | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| persist-credentials: false | |
| - name: Build HTML | |
| uses: ammaraskar/[email protected] | |
| with: | |
| docs-folder: "docs/" | |
| pre-build-command: "sphinx-build -W -b linkcheck . _build" | |
| build-command: "sphinx-build -W -b dirhtml . _build" | |
| - name: Deploy main docs | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| if: github.ref == 'refs/heads/main' | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| folder: docs/_build/ | |
| branch: gh-pages | |
| # CNAME and .nojekyll are left alone by default | |
| clean-exclude: pr-preview | |
| force: false |