Update documentation #33
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 the documentation build | |
on: | |
push: | |
paths: | |
- 'docs/**' | |
branches-ignore: | |
- 'gh-pages' | |
pull_request: | |
workflow_call: | |
workflow_dispatch: | |
permissions: | |
contents: read | |
jobs: | |
check-documentation: | |
name: Check documentation | |
runs-on: "ubuntu-latest" | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
- name: Setup Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: "3.11" | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install -r requirements_docs.txt | |
- name: Check documentation build | |
run: | | |
mkdocs build --strict |