try building docs

.github/workflows/ci.yml

@@ -35,4 +35,24 @@ jobs:
         with:
           name: code-coverage-report
           path: htmlcov/
-          retention-days: 1
+          retention-days: 1
+
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: 'Choose Python version 3.11'
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+      - run: sudo apt-get install -y pandoc
+      - name: install package
+        run: pip install .
+      - name: install doc_reqs
+        run: pip install -r docs_requirements.txt
+      - name: 'run docs-build'
+        run: sphinx-build -j auto -b html "docs/source" "docs/build/html"
+      - uses: actions/upload-pages-artifact@v3.0.1
+        with:
+          path: 'docs/build/html/'

.gitignore

@@ -3,5 +3,4 @@
 __pycache__/
 *.pyc
 *.pytest_cache/
-*.txt
 docs/build/

docs_requirements.txt

@@ -1,3 +1,3 @@
 sphinx<7
 sphinx-rtd-theme
-
+nbsphinx