[DOC] General documentation fixes, using Vale's Google style guide #10
Workflow file for this run
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
name: Test build | |
on: | |
pull_request: | |
jobs: | |
docs: | |
runs-on: ubuntu-22.04 | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v3 | |
- name: Vale | |
uses: pre-commit/[email protected] | |
with: | |
extra_args: vale | |
format: | |
runs-on: ubuntu-22.04 | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v3 | |
- name: Ruff format | |
uses: pre-commit/[email protected] | |
with: | |
extra_args: ruff-format | |
test: | |
strategy: | |
fail-fast: false | |
matrix: | |
python: | |
- "3.8" # oldest Python supported by PSF | |
- "3.9" | |
- "3.10" | |
- "3.11" | |
- "3.12" # newest stable Python | |
runs-on: ubuntu-22.04 | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v3 | |
with: {fetch-depth: 0} # deep clone for setuptools-scm | |
- name: Set up Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: ${{ matrix.python }} | |
- name: Ruff | |
uses: pre-commit/[email protected] | |
with: | |
extra_args: ruff | |
- name: Mypy | |
uses: pre-commit/[email protected] | |
with: | |
extra_args: mypy | |
- name: Install requirements | |
run: | | |
pip3 install --upgrade pip | |
pip3 install setuptools setuptools_scm cmake wheel scikit-build ninja | |
- name: Build package | |
run: | | |
python3 setup.py sdist | |
- uses: actions/upload-artifact@v4 | |
if: ${{ matrix.python == 3.12 }} | |
with: | |
name: python-package | |
path: dist/ |