Skip to content

Check Sphinx external links and references #437

Check Sphinx external links and references

Check Sphinx external links and references #437

name: Check Sphinx external links and references
on:
pull_request:
schedule:
- cron: '0 5 * * *' # once per day at midnight ET
workflow_dispatch:
jobs:
check-external-links:
runs-on: ubuntu-latest
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
steps:
- name: Checkout repo with submodules
uses: actions/checkout@v4
with:
submodules: 'recursive'
fetch-depth: 0 # tags are required for versioneer to determine the version
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Install Sphinx dependencies and package
run: |
python -m pip install --upgrade pip
python -m pip install -r requirements-doc.txt
- name: Check Sphinx links and references
run: sphinx-build -n -W -b linkcheck ./docs/format/source ./test_build