test docs building

.github/workflows/test.yml

@@ -42,3 +42,17 @@ jobs:
       - run: poetry check
       - run: poetry install
       - run: poetry run pytest tests/
+
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: "3.9"
+      - uses: Gr1N/setup-poetry@v4
+      - run: poetry install
+      - run: poetry run sphinx-build -a -W -n -E docs/ docs/_build
+      - uses: actions/upload-artifact@v2
+        with:
+          path: ./docs/_build/

README.rst

@@ -1,8 +1,8 @@
 sysaudit
 ========
 .. image:: https://readthedocs.org/projects/sysaudit/badge/?version=latest
-:target: https://sysaudit.readthedocs.io/en/latest/?badge=latest
-:alt: Documentation Status
+  :target: https://sysaudit.readthedocs.io/en/latest/?badge=latest
+  :alt: Documentation Status
 
 Backport module of `sys.audit <https://docs.python.org/3.8/library/sys.html#sys.audit>`_
 and `sys.addaudithook <https://docs.python.org/3.8/library/sys.html#sys.addaudithook>`_