Update example formatting for better sphinx-gallery rendering #1287
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: Linters | |
| on: | |
| pull_request: | |
| # Build when a pull request targets main | |
| branches: | |
| - main | |
| jobs: | |
| linter: | |
| name: Lint checks | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 10 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| name: Checkout the repository | |
| with: | |
| fetch-depth: 100 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.10' | |
| - name: Check example keywords | |
| run: python3 doc/example-keywords.py compare | |
| - name: Get changed C++ files | |
| if: success() || failure() | |
| id: changed-cxx-files | |
| uses: tj-actions/changed-files@v41 | |
| with: | |
| files: | | |
| **.h | |
| **.cpp | |
| # Comment blocks starting with "/*!" do not support autobrief | |
| - name: Check for problematic Doxygen comment blocks | |
| if: (success() || failure()) && steps.changed-cxx-files.outputs.any_changed == 'true' | |
| run: | | |
| RETCODE=0 | |
| for file in ${{ steps.changed-cxx-files.outputs.all_changed_files }}; do | |
| RESULT=`perl -0777 -ne 'while(m/\n\n *\/\*!.*?\*\//gs){print "$&\n";}' $file` | |
| if [ "$RESULT" ]; then | |
| echo ------ ${file} ------ | |
| echo "$RESULT" | |
| RETCODE=1 | |
| fi | |
| done | |
| exit $RETCODE | |
| - name: Whitespace errors | |
| if: success() || failure() | |
| run: | | |
| # These are files that should be ignored for whitespace checks | |
| echo ".gitmodules -diff" >> .gitattributes | |
| echo "*.sln -diff" >> .gitattributes | |
| echo "test/data/*.inp -diff" >> .gitattributes | |
| echo "test/data/*.xml -diff" >> .gitattributes | |
| echo "test/data/*.cti -diff" >> .gitattributes | |
| echo "test_problems/**/*blessed* -diff" >> .gitattributes | |
| git config --global core.autocrlf false | |
| git config --global core.whitespace \ | |
| -cr-at-eol,tab-in-indent,blank-at-eol,blank-at-eof | |
| git diff --check ${{ github.event.pull_request.base.sha }} |