Create Executables section (#42) #109
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: "Check document files" | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| branches: | |
| - main | |
| concurrency: | |
| # If workflow is currently running, stop it and start a new one. | |
| group: check-${{ github.ref }} | |
| cancel-in-progress: true | |
| permissions: read-all | |
| jobs: | |
| #--------------------------------------------------------------------- | |
| # 1-markdownlint | |
| #--------------------------------------------------------------------- | |
| markdownlint: | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - id: changed | |
| uses: tj-actions/changed-files@v45 | |
| with: | |
| files: | | |
| **.md | |
| - name: Lint markdown files | |
| if: steps.changed.outputs.any_changed == 'true' | |
| uses: nosborn/[email protected] | |
| with: | |
| files: ${{ steps.changed.outputs.all_changed_files }} | |
| config_file: .markdownlint.json | |
| #--------------------------------------------------------------------- | |
| # 2-rstdoc8 | |
| #--------------------------------------------------------------------- | |
| rstdoc8: | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Install doc8 | |
| run: | | |
| pip3 install doc8 | |
| - id: changed | |
| uses: tj-actions/changed-files@v45 | |
| with: | |
| files: | | |
| **.rst | |
| - name: Lint restructured text files | |
| if: steps.changed.outputs.any_changed == 'true' | |
| run: | | |
| doc8 --ignore D001 ${{ steps.changed.outputs.all_changed_files }} | |
| #--------------------------------------------------------------------- | |
| # 3-rstcheck | |
| #--------------------------------------------------------------------- | |
| rstcheck: | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Install rstcheck | |
| run: | | |
| pip3 install rstcheck[sphinx] | |
| - name: Get new and changed restructured text files | |
| id: changed | |
| uses: tj-actions/changed-files@v45 | |
| with: | |
| files: | | |
| **.rst | |
| - name: Check restructured text files | |
| if: steps.changed.outputs.any_changed == 'true' | |
| run: | | |
| rstcheck ${{ steps.changed.outputs.all_changed_files }} | |
| #--------------------------------------------------------------------- | |
| # 4-sphinx-build | |
| #--------------------------------------------------------------------- | |
| sphinx-build: | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 10 | |
| permissions: | |
| contents: write | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: pip install | |
| run: | | |
| sudo pip install sphinx sphinx_rtd_theme myst_parser | |
| - id: pages | |
| uses: actions/configure-pages@v5 | |
| - name: build sphinx document | |
| run: | | |
| sphinx-build -W docs/ _build | |
| - name: deploy html to gh-pages branch | |
| uses: peaceiris/actions-gh-pages@v4 | |
| if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} | |
| with: | |
| publish_branch: gh-pages | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: _build/ | |
| force_orphan: true |