add doc workflow #4
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, pull_request] | ||
| jobs: | ||
| build: | ||
| name: Build documentation | ||
| jobs: | ||
| build: | ||
| # This build is to make PR comments for the sphinx warning and check if | ||
| # web links are not broken | ||
| name: Documentation: Check links and make PR comments | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
| - uses: actions/setup-python@v5 | ||
| name: Install Python | ||
| with: | ||
| python-version: '3.11' | ||
| - name: Install build docs | ||
| shell: bash -l {0} | ||
| run: | | ||
| pip install .[doc] | ||
| # - name: Run doctest | ||
| # shell: bash -l {0} | ||
| # run: | | ||
| # cd ./doc | ||
| # pytest --doctest-modules --doctest-glob="*.rst" -n 2 -v | ||
| # Add sphinx warnings as PR comments | ||
| - uses: sphinx-doc/sphinx-problem-matcher@master | ||
| - name: Build documentation | ||
| shell: bash -l {0} | ||
| run: | | ||
| cd ./doc | ||
| make SPHINXOPTS="-W --keep-going" html | ||
| - uses: actions/upload-artifact@v4 | ||
| with: | ||
| path: ./doc/_build/html/ | ||
| name: doc_html | ||
| - name: Check links | ||
| shell: bash -l {0} | ||
| run: | | ||
| cd ./doc | ||
| make linkcheck | ||
