Skip to content

WIP, BUG: Implement custom role for numpydoc parameters. #444

WIP, BUG: Implement custom role for numpydoc parameters.

WIP, BUG: Implement custom role for numpydoc parameters. #444

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:
runs-on: ${{ matrix.os }}-latest
strategy:
matrix:
os: [Ubuntu]
python-version: ["3.8", "3.9", "3.10", "3.11"]
sphinx-version:
[
"sphinx==5.0",
"sphinx==5.3",
"sphinx==6.0",
"sphinx==6.2",
"sphinx>=7.0",
]
steps:
- uses: actions/checkout@v3
- name: Python setup
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Setup environment
run: |
python -m pip install --upgrade pip wheel setuptools
python -m pip install -r requirements/test.txt -r requirements/doc.txt
python -m pip install codecov
python -m pip install ${{ matrix.sphinx-version }}
python -m pip list
- name: Install
run: |
python -m pip install .
pip list
- name: Run test suite
run: |
pytest -v --pyargs numpydoc
- name: Test coverage
run: |
codecov
- name: Make sure CLI works
run: |
python -m numpydoc numpydoc.tests.test_main._capture_stdout
echo '! python -m numpydoc numpydoc.tests.test_main._invalid_docstring' | bash
python -m numpydoc --validate numpydoc.tests.test_main._capture_stdout
echo '! python -m 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"
prerelease:
runs-on: ${{ matrix.os }}-latest
strategy:
matrix:
os: [ubuntu]
python-version: ["3.9", "3.10"]
steps:
- uses: actions/checkout@v3
- name: Python setup
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Setup environment
run: |
python -m pip install --upgrade pip wheel setuptools
python -m pip install --pre -r requirements/test.txt -r requirements/doc.txt
python -m pip install codecov
python -m pip list
- name: Install
run: |
python -m pip install .
pip list
- name: Run test suite
run: |
pytest -v --pyargs .
- name: Test coverage
run: |
codecov
- name: Make sure CLI works
run: |
python -m numpydoc numpydoc.tests.test_main._capture_stdout
echo '! python -m numpydoc numpydoc.tests.test_main._invalid_docstring' | bash
python -m numpydoc --validate numpydoc.tests.test_main._capture_stdout
echo '! python -m 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"