summaryrefslogtreecommitdiff
path: root/.github/workflows/test.yml
blob: fa580dcefd79e8b9b8d20669b54cfcfde2c46730 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
name: numpydoc tests

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  test:
    runs-on: ${{ matrix.os }}-latest
    strategy:
      matrix:
        os: [Ubuntu]
        python-version: ["3.7", "3.8", "3.9", "3.10"]
        sphinx-version: ["sphinx==3.0", "sphinx==4.0", "sphinx>4.4"]
    steps:
      - uses: actions/checkout@v2

      - name: Python setup
        uses: actions/setup-python@v2
        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 doc/requirements.txt
          python -m pip install codecov
          python -m pip install ${{ matrix.sphinx-version }}
          python -m pip list

      - name: Downgrade Jinja2 for sphinx<4
        if: ${{ matrix.sphinx-version }} == 'sphinx<4.0.2'
        run: python -m pip install jinja2==3.0.3

      - 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"