Skip to content

Commit

Permalink
add docs tests
Browse files Browse the repository at this point in the history
  • Loading branch information
Archmonger committed Jul 1, 2024
1 parent 3865331 commit 81fdca4
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions .github/workflows/test-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
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/
Empty file added CHANGELOG.md
Empty file.

0 comments on commit 81fdca4

Please sign in to comment.