Add docs tests #41
Workflow file for this run
This file contains 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: Test | |
on: | |
push: | |
branches: | |
- main | |
pull_request: | |
branches: | |
- main | |
schedule: | |
- cron: "0 0 * * *" | |
jobs: | |
docs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: 3.x | |
- name: Check docs build | |
run: | | |
pip install -r requirements/docs.txt | |
linkcheckMarkdown docs/ -v -r | |
linkcheckMarkdown README.md -v -r | |
linkcheckMarkdown CHANGELOG.md -v -r | |
cd docs | |
mkdocs build --strict | |
# - name: Check docs examples | |
# run: | | |
# pip install -r requirements/check-types.txt | |
# pip install -r requirements/check-style.txt | |
# mypy --show-error-codes docs/ | |
# ruff check docs/ |