Add note that only file rules can be used to validate files #3625
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
# When a Pull Request is opened that modifies | |
# the User Guide source, build the User Guide | |
# with Sphinx and let the contributor know of | |
# any errors. | |
name: Test User Guide | |
on: | |
pull_request: | |
paths: | |
- 'user_guide_src/**' | |
- '.github/workflows/test-userguide.yml' | |
concurrency: | |
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} | |
cancel-in-progress: true | |
permissions: | |
contents: read | |
jobs: | |
syntax_check: | |
name: Check User Guide syntax | |
runs-on: ubuntu-22.04 | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
- name: Detect usage of tabs in RST files | |
run: php utils/check_tabs_in_rst.php | |
- uses: ammaraskar/[email protected] | |
with: | |
docs-folder: user_guide_src | |
build-command: 'make html SPHINXOPTS="-W --keep-going -w /tmp/sphinx-log"' |