Use intersphinx_registry #272
Workflow file for this run
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: Test docs | |
| on: | |
| pull_request: | |
| push: | |
| branches-ignore: | |
| - "dependabot/**" | |
| - "pre-commit-ci-update-config" | |
| tags: | |
| - "**" | |
| workflow_dispatch: | |
| env: | |
| # UTF-8 content may be interpreted as ascii and causes errors without this. | |
| LANG: C.UTF-8 | |
| PYTEST_ADDOPTS: "--verbose --color=yes" | |
| jobs: | |
| test-docs: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| # make rediraffecheckdiff requires git history to compare current | |
| # commit with the main branch and previous releases. | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.10" | |
| - name: Install requirements | |
| run: | | |
| pip install -r docs/requirements.txt . | |
| # readthedocs doesn't halt on warnings, | |
| # so raise any warnings here | |
| - name: build docs | |
| run: | | |
| cd docs | |
| make html | |
| - name: check links | |
| run: | | |
| cd docs | |
| make linkcheck | |
| # make rediraffecheckdiff compares files for different changesets | |
| # these diff targets aren't always available | |
| # - compare with base ref (usually 'main', always on 'origin') for pull requests | |
| # - only compare with tags when running against main repo | |
| # to avoid errors on forks, which often lack tags | |
| - name: check redirects for this PR | |
| if: github.event_name == 'pull_request' | |
| run: | | |
| cd docs | |
| export REDIRAFFE_BRANCH=origin/${{ github.base_ref }} | |
| make rediraffecheckdiff | |
| # this should check currently published 'stable' links for redirects | |
| - name: check redirects since last release | |
| if: github.repository == 'ipython/ipyparallel' | |
| run: | | |
| cd docs | |
| export REDIRAFFE_BRANCH=$(git describe --tags --abbrev=0) | |
| make rediraffecheckdiff | |
| # longer-term redirect check (fixed version) for older links | |
| - name: check redirects since 8.6.0 | |
| if: github.repository == 'ipython/ipyparallel' | |
| run: | | |
| cd docs | |
| export REDIRAFFE_BRANCH=8.6.0 | |
| make rediraffecheckdiff |