Update __init__.py #285
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
| # This workflow will install Python dependencies, run tests and lint with a variety of Python versions | |
| # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions | |
| name: docs | |
| on: [push, pull_request] | |
| jobs: | |
| doc: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: [3.8] | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v2 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install .[doc] | |
| - name: Build HTML docs | |
| id: linkcheck | |
| run: | | |
| make -C docs html linkcheck 2>&1 | tee check.log | |
| echo "::set-output name=broken::$(grep '(line\s*[0-9]*)\(\s\)broken\(\s\)' check.log)" | |
| env: | |
| SPHINXOPTS: -nW --keep-going | |
| - name: Show docs build check results | |
| run: | | |
| if [ -z "${{ steps.linkcheck.outputs.broken }}" ]; then | |
| echo "No broken links found." | |
| exit 0 | |
| else | |
| echo "Broken links found:" | |
| echo "${{ steps.linkcheck.outputs.broken }}" | |
| exit 1 | |
| fi |