Skip to content
Test, build, and generate docs

Update docs #15

Sign in to view logs

Update docs

Update docs #15

Workflow file for this run

.github/workflows/pre-release.yml at 22558e7
# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
name: Test, build, and generate docs
on:
push:
branches:
- '**'
- '!main'
jobs:
test:
name: Test Python versions
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ['3.10', '3.11', '3.12']
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install flake8 pytest pytest-pretty
- name: Lint with flake8
run: |
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings. The project default is 100 char lines
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=100 --statistics
- name: Test with pytest
run: |
pytest
build:
name: Regenerate documentation
needs: test
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install -r requirements-dev.txt
- name: Build the packages
run: |
python -m build
- name: Generate documentation
run: |
sphinx-build -b html docsrc docs -E -d "docsrc/_doctrees"
- name: Check if there are any changes
id: verify_diff
run: |
git diff --quiet . || echo "changed=true" >> $GITHUB_OUTPUT
- name: Commit and push the new documentation
if: steps.verify_diff.outputs.changed == 'true'
run: |
git config user.name "Brian Warner"
git config user.email [email protected]
git add docs
git commit -s -m "Rebuild the documentation" || exit 0
git push