From d2f434988fa544bff1a153d8c440e3a234dd1e2b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Leon=20M=C3=B6ller?= Date: Wed, 20 Dec 2023 19:03:31 +0100 Subject: [PATCH] ci: add check for sphinx autodocs Fix #115 --- .github/workflows/ci.yml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 0ac860af9..94ea342d1 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -89,6 +89,24 @@ jobs: run: | codeblocks python README.md | python + docs: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + - name: Set up Python 3.10 + uses: actions/setup-python@v2 + with: + python-version: "3.10" + - name: Install Python dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements.txt + pip install -r docs/add-requirements.txt + - name: Check documentation for errors + run: | + SPHINXOPTS="-a -E -n -W --keep-going" make -C docs html + package: runs-on: ubuntu-latest