chore: test documentation (#145)

* chore: Test documentation * docs: fix broken links
2020-12-30 16:59:22 +01:00
parent 52fcbfbcdf
commit 0ffb28c3d6
7 changed files with 22 additions and 7 deletions
@@ -37,10 +37,23 @@ jobs:
    - name: Spec test
      run: |
        docker run --mount type=bind,source=$(pwd)/build/kapow,target=/usr/local/bin/kapow  bbvalabsci/kapow-spec-test-suite:latest behave --tags=~@skip
+  doc-test:
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v2
+    - name: Prepare Python env
+      run: |
+        sudo apt-get install -y pipenv
+        cd docs
+        pipenv sync
+    - name: Check for warnings & broken links
+      run: |
+        cd docs
+        SPHINXOPTS="-qW --keep-going" pipenv run make linkcheck html
  release:
    if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
    runs-on: ubuntu-20.04
-    needs: [ unit-test, spec-test ]
+    needs: [ unit-test, spec-test, doc-test ]
    steps:
    - uses: actions/checkout@v2
      with: