Skip to content

docs: update README links to new documentation site #2292

docs: update README links to new documentation site

docs: update README links to new documentation site #2292

Workflow file for this run

name: Python application
on: [push, pull_request]
jobs:
test:
name: Test (${{ matrix.os }})
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, windows-latest, macos-latest]
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install dependencies
run: pip install -e .[dev,interop]
- name: Run tests with coverage
if: matrix.os == 'ubuntu-latest'
run: |
coverage run -m pytest
coverage report -m
- name: Run tests
if: matrix.os != 'ubuntu-latest'
run: pytest
lint:
name: Lint
runs-on: ubuntu-latest
if: github.event_name == 'pull_request'
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install flake8
run: pip install flake8
- name: Lint with flake8
run: flake8 .
docs:
name: Build Docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install dependencies
run: pip install -e .[dev,interop]
- name: Build docs
run: make -C docs html
publish:
name: Publish to PyPI
runs-on: ubuntu-latest
needs: [test, docs]
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Build and publish
run: |
pip install build twine
python -m build
twine upload dist/*
env:
TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ secrets.pypi_password }}