Skip to content
4 changes: 2 additions & 2 deletions .github/workflows/documentation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ jobs:
python -m pip install -r docs/requirements.txt
- name: Build docs
run: ./.github/jobs/build_documentation.sh
- uses: actions/upload-artifact@v4
- uses: actions/upload-artifact@v7
if: always()
with:
name: documentation
path: artifact/documentation
- uses: actions/upload-artifact@v4
- uses: actions/upload-artifact@v7
if: failure()
with:
name: documentation_warnings.log
Expand Down
19 changes: 19 additions & 0 deletions .github/workflows/linkcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Linkcheck
on:
schedule:
- cron: '0 6 * * 1'
pull_request:
paths:
- 'docs/**'
workflow_dispatch: {}

jobs:
linkcheck:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: dtcenter/metplus-action-linkcheck@v1
with:
fail-on-broken-links: 'true'
upload-artifact: 'true'
install-package: 'true'
2 changes: 1 addition & 1 deletion .github/workflows/unit_tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ jobs:
coverage html

- name: Archive code coverage results
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v7
with:
name: code-coverage-report_py${{ matrix.python-version }}
path: htmlcov/index.html
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/version_tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ jobs:
coverage html

- name: Archive code coverage results
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v7
with:
name: code-coverage-report
path: htmlcov/index.html
Expand Down
23 changes: 22 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,28 @@
numfig_format = {
'figure': 'Figure %s',
}


# -- linkcheck builder configuration ----------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder

linkcheck_timeout = 10
linkcheck_retries = 2
linkcheck_workers = 8

linkcheck_ignore = [
# add regex patterns for URLs that should be skipped, e.g.:
# r'https://dtcenter\.org/.*', # if this site blocks automated requests
# r'https://doi\.org/.*',
# r'https://journals\.ametsoc\.org/.*', # AMS journal site blocks bot user-agents
]

linkcheck_allowed_redirects = {
# map of regex -> regex for redirects that are fine to follow
}

linkcheck_anchors = True
linkcheck_anchors_ignore = ['^!']

# -- Export variables --------------------------------------------------------

rst_epilog = """
Expand Down
Loading