Added workflow to check documentation #6
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 check | |
| on: | |
| push: | |
| pull_request: | |
| branches: [ "master", "dev" , "experimental" ] | |
| jobs: | |
| tests: | |
| name: documentation check | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/[email protected] | |
| - name: Run script and save results | |
| run: python docs/script/make_doc.py README.tmp | |
| - name: Compare temp file with readme.rst | |
| run: diff -u README.rst README.tmp > doc_cmp.result | |
| - name: Fail build if files are not identical | |
| run: | | |
| if [ $? -ne 0 ]; then | |
| echo "Files are not identical" | |
| cat doc_cmp.result | |
| exit 1 | |
| fi |