merge docs (#2)

* docs added * docs consistency check * complete docs
Zeeonome · Jan 8, 2024 · 4b7240c · 4b7240c
1 parent 2d37488
commit 4b7240c
Show file tree

Hide file tree

Showing 5 changed files with 685 additions and 0 deletions.
diff --git a/.github/workflows/lint_and_test.yaml b/.github/workflows/lint_and_test.yaml
@@ -29,3 +29,7 @@ jobs:
         run: poetry run ruff --exit-non-zero-on-fix .
       - name: Test with pytest
         run: poetry run pytest
+      - name: Compare docs
+        run: | 
+          poetry run pdoc crossense -o ./docs_new
+          diff -r ./docs ./docs_new || exit 1