Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed #32723 -- Add a GitHub action to run the Sphinx linkcheck builder #14390

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
39 changes: 39 additions & 0 deletions .github/workflows/linkcheck.yml
@@ -0,0 +1,39 @@
name: Linkcheck

on:
schedule:
- cron: "0 14 * * 1" # Every Monday at 2PM UTC

jobs:
linkcheck:
runs-on: ubuntu-latest
name: linkcheck
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: 3.9
- name: Cache dependencies
uses: actions/cache@v2
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- run: python -m pip install -r docs/requirements.txt
- name: Build docs
run: |
cd docs
sphinx-build -b spelling -n -q -W --keep-going -d _build/doctrees -D language=en_US -j auto . _build/spelling
- name: Linkcheck docs
run: |
cd docs
sphinx-build -b linkcheck ../docs/ _build/linkcheck
- name: Upload linkcheck output
uses: actions/upload-artifact@v2
if: ${{ always() }}
with:
name: linkcheck
path: docs/_build/linkcheck/