Skip to content

More CI updates

More CI updates #841

Workflow file for this run

name: numpydoc tests
concurrency:
group: ${{ github.workflow }}-${{ github.event.number }}-${{ github.event.ref }}
cancel-in-progress: true
on:
push:
branches: [main]
pull_request:
branches: [main]
jobs:
test-oldsphinx:
runs-on: ${{ matrix.os }}-latest
strategy:
matrix:
os: [Ubuntu]
python-version: ["3.10", "3.11"]
sphinx-version: ["sphinx<7", "sphinx<8"]
defaults:
run:
shell: bash -eo pipefail {0}
steps:
- uses: actions/checkout@v5
- name: Python setup
uses: actions/setup-python@v6
with:
python-version: ${{ matrix.python-version }}
- name: Setup environment
run: |
python -m pip install --upgrade pip wheel setuptools
python -m pip install "${{ matrix.sphinx-version }}"
python -m pip list
- name: Install
run: |
python -m pip install . --group test --group doc
pip list
- name: Run test suite
run: |
pytest -v --pyargs numpydoc
- name: Make sure CLI works
run: |
numpydoc render numpydoc.tests.test_main._capture_stdout
echo '! numpydoc render numpydoc.tests.test_main._invalid_docstring' | bash
numpydoc validate numpydoc.tests.test_main._capture_stdout
echo '! numpydoc validate numpydoc.tests.test_main._docstring_with_errors' | bash
- name: Setup for doc build
run: |
sudo apt-get update
sudo apt install texlive texlive-latex-extra latexmk dvipng
- name: Build documentation
run: |
make -C doc html SPHINXOPTS="-nT"
make -C doc latexpdf SPHINXOPTS="-nT"
test:
runs-on: ${{ matrix.os }}-latest
strategy:
matrix:
os: ["ubuntu", "macos", "windows"]
python-version: ["3.12", "3.13", "3.14"]
steps:
- uses: actions/checkout@v5
- name: Python setup
uses: actions/setup-python@v6
with:
python-version: ${{ matrix.python-version }}
- name: Setup environment
run: |
python -m pip install --upgrade pip wheel setuptools
python -m pip list
- name: Install
run: |
python -m pip install . --group test --group doc
pip list
- name: Run test suite
run: |
pytest -v --pyargs numpydoc
- name: Make sure CLI works
if: runner.os == 'Linux'
run: |
numpydoc render numpydoc.tests.test_main._capture_stdout
echo '! numpydoc render numpydoc.tests.test_main._invalid_docstring' | bash
numpydoc validate numpydoc.tests.test_main._capture_stdout
echo '! numpydoc validate numpydoc.tests.test_main._docstring_with_errors' | bash
- name: Setup for doc build
if: runner.os == 'Linux'
run: |
sudo apt update
sudo apt install -y texlive texlive-latex-extra latexmk dvipng
- name: Build documentation
if: runner.os == 'Linux'
run: |
make -C doc html SPHINXOPTS="-nT"
make -C doc latexpdf SPHINXOPTS="-nT"
prerelease:
runs-on: ${{ matrix.os }}-latest
strategy:
matrix:
os: [ubuntu]
python-version: ["3.12", "3.13", "3.14"]
steps:
- uses: actions/checkout@v5
- name: Python setup
uses: actions/setup-python@v6
with:
python-version: ${{ matrix.python-version }}
- name: Setup environment
run: |
python -m pip install --upgrade pip wheel setuptools
python -m pip list
- name: Install
run: |
python -m pip install --pre . --group test --group doc
pip list
- name: Run test suite
run: |
pytest -v --pyargs .
- name: Make sure CLI works
run: |
numpydoc render numpydoc.tests.test_main._capture_stdout
echo '! numpydoc render numpydoc.tests.test_main._invalid_docstring' | bash
numpydoc validate numpydoc.tests.test_main._capture_stdout
echo '! numpydoc validate numpydoc.tests.test_main._docstring_with_errors' | bash
- name: Setup for doc build
run: |
sudo apt-get update
sudo apt install texlive texlive-latex-extra latexmk dvipng
- name: Build documentation
run: |
make -C doc html SPHINXOPTS="-nT"
make -C doc latexpdf SPHINXOPTS="-nT"
coverage:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- name: Python setup
uses: actions/setup-python@v6
with:
python-version: "3.13"
- name: Setup environment
run: |
python -m pip install --upgrade pip wheel setuptools
python -m pip install codecov
python -m pip list
- name: Install
run: |
python -m pip install --pre . --group test --group doc
pip list
- name: Run test suite
run: |
pytest -v --pyargs numpydoc
- name: Test coverage
run: |
codecov