Refactor group_nodes_by_folder hierarchical naming to be opt-in
#904
Workflow file for this run
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: Build Sphinx documentation | |
| on: | |
| # Run this workflow when documentation sources or this workflow definition change. | |
| push: | |
| branches: [main] | |
| paths: | |
| - "docs/**" | |
| - "cosmos/**" | |
| - ".github/workflows/docs-build.yml" | |
| - "lychee.toml" | |
| pull_request: | |
| branches: [main, 'release-*'] | |
| paths: | |
| - "docs/**" | |
| - "cosmos/**" | |
| - ".github/workflows/docs-build.yml" | |
| - "lychee.toml" | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| steps: | |
| - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 | |
| with: | |
| ref: ${{ github.event.pull_request.head.sha || github.ref }} | |
| persist-credentials: false | |
| - uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0 | |
| with: | |
| python-version: "3.11" | |
| - name: Install documentation dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -r docs/requirements.txt | |
| - name: Build Sphinx documentation | |
| run: sphinx-build -b html docs docs/_build --fail-on-warning --fresh-env | |
| linkcheck: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| steps: | |
| - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 | |
| with: | |
| ref: ${{ github.event.pull_request.head.sha || github.ref }} | |
| persist-credentials: false | |
| - name: Check links in documentation | |
| # Uses the lychee link checker. Behaviour (which hosts to skip, retries, | |
| # accepted status codes for throttling hosts) is configured in the | |
| # repo-root lychee.toml. Fails the job on genuinely broken links. | |
| uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2.8.0 | |
| with: | |
| args: "--no-progress --config lychee.toml 'docs/**/*.rst'" | |
| fail: true |