Skip to content

[DOC]: workflow to check links automatically #1794

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.

Sign up for GitHub

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

Closed
wants to merge 6 commits into from
Closed

[DOC]: workflow to check links automatically #1794

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1c4bc1d
Add nitpicky = True
echedey-ls Jun 29, 2023
a09fa8f
Github action to schedule running the sphinx linkchecker
echedey-ls Jul 15, 2023
24922ec
Apply working ubuntu workflow
echedey-ls Jul 27, 2023
14c99da
Delete nitpicky
echedey-ls Jul 27, 2023
1cec3d3
Ah, I forgot this
echedey-ls Jul 27, 2023
0307da4
Merge branch 'main' into warn-about-broken-links
echedey-ls Jul 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions .github/workflows/links_check.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Check Documentation Links

on:
schedule:
# Biweekly at 00:00 on first and third Mondays
- cron: "0 0 1-7,15-21 * 1"
workflow_dispatch:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
doc:
name: Check Links
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- uses: actions/setup-python@v4
with:
python-version: "3.8"

- name: Install PVLIB documentation dependencies
run: python -m pip install -e .[doc]

- name: Run Sphinx linkcheck builder
run: |
cd docs/sphinx
python -m sphinx -b linkcheck -T -W --keep-going source build/linkcheck
Loading