MkDocs #25
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: MkDocs | |
on: | |
workflow_run: | |
workflows: ['CI build'] | |
types: | |
- completed | |
jobs: | |
lint: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- name: 'Set up Python 3.11' | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.11' | |
- name: Install dependencies | |
run: | | |
pip install --upgrade pip | |
pip install '.[docs]' | |
- name: Lint documentation | |
run: pydocstyle **/*.py --verbose | |
build: | |
runs-on: ubuntu-latest | |
needs: lint | |
steps: | |
- uses: actions/checkout@v4 | |
- name: 'Set up Python 3.11' | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.11' | |
- name: Install dependencies | |
run: | | |
pip install --upgrade pip | |
pip install '.[docs]' | |
- name: Perform documentation tests | |
run: mkdocs build | |
test: | |
runs-on: ubuntu-latest | |
needs: build | |
steps: | |
- uses: actions/checkout@v4 | |
- name: 'Set up Python 3.11' | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.11' | |
- name: Test readme examples | |
run: python -m doctest README.md | |
- name: Check documentation coverage | |
run: docstr-coverage **/*.py | |
publish: | |
if: github.ref == 'refs/heads/main' | |
runs-on: ubuntu-latest | |
needs: test | |
steps: | |
- uses: actions/checkout@v4 | |
- name: 'Set up Python 3.11' | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.11' | |
- name: Publish documentation | |
run: mkdocs gh-deploy |