Docs/cleanup readme #24
This file contains hidden or 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: docs-check | |
| on: | |
| pull_request: | |
| paths: | |
| - "docs-mkdocs/**" | |
| - "mkdocs.yml" | |
| - "docs/requirements-mkdocs.txt" | |
| workflow_dispatch: | |
| jobs: | |
| build-strict: | |
| name: MkDocs strict build | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Install docs dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -r docs/requirements-mkdocs.txt | |
| - name: Build (strict — treats warnings as errors) | |
| run: mkdocs build --strict | |
| link-check: | |
| name: External link checker | |
| runs-on: ubuntu-latest | |
| needs: build-strict | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Lychee link check | |
| uses: lycheeverse/lychee-action@v2 | |
| with: | |
| # Check all markdown in docs-mkdocs/ | |
| args: >- | |
| --verbose --no-progress --exclude-path | |
| docs-mkdocs/climate-data-interface/processors/TEMPLATE.md | |
| --exclude "https://mybinder.org" --exclude | |
| "https://cal-adapt.github.io/climakitae" --exclude | |
| "https://github.com/cal-adapt/climakitae/blob" | |
| "docs-mkdocs/**/*.md" | |
| fail: true | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |