Enable live visualizations in Read the Docs documentation #23
This file contains hidden or 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: CI | |
| on: | |
| push: | |
| branches: [ main, develop ] | |
| pull_request: | |
| branches: [ main ] | |
| jobs: | |
| test: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ["3.8", "3.9", "3.10", "3.11"] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -e .[dev] | |
| - name: Lint with flake8 | |
| run: | | |
| flake8 pycancensus --count --select=E9,F63,F7,F82 --show-source --statistics | |
| flake8 pycancensus --count --exit-zero --max-complexity=10 --max-line-length=88 --statistics | |
| - name: Check formatting with black | |
| run: | | |
| black --check pycancensus | |
| - name: Test with pytest | |
| run: | | |
| pytest --cov=pycancensus --cov-report=xml | |
| - name: Upload coverage to Codecov | |
| uses: codecov/codecov-action@v3 | |
| with: | |
| file: ./coverage.xml | |
| fail_ci_if_error: false | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.11" | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -e .[docs,dev] | |
| - name: Build docs | |
| run: | | |
| cd docs | |
| make html | |
| - name: Check for broken links | |
| run: | | |
| cd docs | |
| make linkcheck || true |