Skip to content

doc: Fixed link

doc: Fixed link #6

Workflow file for this run

name: CI
permissions:
contents: read
id-token: write
on:
push:
branches: ["main"]
tags:
- "v*"
pull_request:
branches: ["main"]
jobs:
tests:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version: ["3.10"]
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -e .[dev]
- name: Run tests
run: |
pytest || if [ $? -eq 5 ]; then echo "No tests collected; skipping."; exit 0; else exit $?; fi
publish:
needs: tests
if: startsWith(github.ref, 'refs/tags/v')
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Install build tooling
run: |
python -m pip install --upgrade pip
pip install build twine setuptools_scm
- name: Build package
run: python -m build
- name: Check metadata
run: python -m twine check dist/*
- name: Publish to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
with:
password: ${{ secrets.PYPI_API_TOKEN }}
docs:
needs: tests
if: startsWith(github.ref, 'refs/tags/v')
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Install docs dependencies
run: |
python -m pip install --upgrade pip
pip install -e .[docs]
- name: Build and deploy docs
run: mkdocs gh-deploy --force