document the querystringSearchGet setting #1920
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: Documentation | |
on: | |
push: | |
branches: | |
- master | |
paths: | |
- 'docs/**' | |
# Build pull requests | |
pull_request: | |
paths: | |
- 'docs/**' | |
- 'styles/**' | |
jobs: | |
docs: | |
name: Documentation | |
runs-on: ubuntu-latest | |
strategy: | |
matrix: | |
python-version: ['3.10'] | |
steps: | |
- uses: actions/checkout@v3 | |
- name: Set up Python ${{ matrix.python-version }} | |
uses: actions/setup-python@v4 | |
with: | |
python-version: ${{ matrix.python-version }} | |
cache: 'pip' | |
- name: Create Python virtual environment | |
run: pip install virtualenv | |
- name: pip install requirements | |
run: pip install -r requirements-docs.txt | |
- name: Check for broken links | |
run: make docs-linkcheckbroken | |
- name: Build HTML documentation | |
run: make docs-html | |
- uses: errata-ai/vale-action@reviewdog | |
with: | |
# debug: true | |
files: all | |
env: | |
# Required, set by GitHub actions automatically: | |
# https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret | |
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} |