Merge pull request #4900 from RoboJackets/renovate/lock-file-maintenance #117
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: Docs | |
on: | |
push: | |
branches: | |
- main | |
paths: | |
- 'docs/**' | |
pull_request: | |
branches: | |
- main | |
paths: | |
- 'docs/**' | |
jobs: | |
docs: | |
name: Build Docs | |
runs-on: ubuntu-latest | |
defaults: | |
run: | |
working-directory: docs/ | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
- name: Register problem matchers | |
run: echo "::add-matcher::.github/matchers.json" | |
- name: Setup Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.12' | |
- name: Setup Poetry | |
uses: abatilo/actions-poetry@v3 | |
- name: Cache the virtualenv | |
uses: actions/cache@v4 | |
with: | |
path: ~/.cache/pypoetry | |
key: venv-${{ hashFiles('poetry.lock') }} | |
- name: Install Poetry dependencies | |
run: poetry install | |
- name: Build Sphinx docs | |
run: poetry run sphinx-build -M dirhtml . _build | |
- name: Run Vale | |
uses: docker://jdkato/vale | |
with: | |
entrypoint: /bin/sh | |
args: -euxc "cd docs && vale sync && vale ." |