DEBUG

.github/workflows/docs.yaml

@@ -27,14 +27,15 @@ jobs:
 
       - name: Generate API docs
         run: |
-          sphinx-apidoc -o /tmp/docs tus_storagehandler/
+          poetry run sphinx-apidoc -o /tmp/docs tus_storagehandler/
 
       - name: Compare docs with main branch
         id: check_docs_diff
         run: |
           shasum /tmp/docs/* > /tmp/docs.sha
-          shasum /docs/pages/* > /docs/project_doc.sha
-          diff=$(diff /tmp/docs.sha /docs/project_doc.sha) || true
+          rm -f docs/pages/.gitkeep # Remove placeholder file
+          shasum docs/pages/* > docs/project_doc.sha
+          diff=$(diff /tmp/docs.sha docs/project_doc.sha) || true
           if [[ -n "$diff" ]]; then
             echo "::error::API documentation is out of date."
             exit 1

Makefile

@@ -69,8 +69,8 @@ fl: format-lint
 
 .PHONY: install
 install:
-	@echo "\nInstalling dependencies and with this package +++++++++++++++++++++++++++++++++\n"
-	@poetry install
+	@echo "\nInstalling all dependencies and with this package +++++++++++++++++++++++++++++++++\n"
+	@poetry install --with=code_quality,docs,misc,test,types,vulnerability
 
 .PHONY: i
 i: install

docs/pages/modules.rst

@@ -0,0 +1,7 @@
+tus_storagehandler
+===================
+
+.. toctree::
+   :maxdepth: 4
+
+   tus_storagehandler