Annotation improvements (#602)

* WIP

* WIP

* WIP

* docs: add links to changelogs

* refactoring

* renaming everything consistently to volume_layer

* more stuff

* merge master and add upload & description & orga

* fixes

* upgrade wkcuber deps

* add changelog entries

* add docs for annotation, minor fixes

* formatting

* add skeleton docs, make _element_id_generator pseudo-private

* apply PR feedback, fix test

* add more tests

* fix changelog

* 🤬 pylint

* formatting

Author: jstriebel

docs/generate.sh

@@ -15,7 +15,7 @@ if [ ! -d "wk-repo" ]; then
     exit 1
 fi
 
-export PDOC_CLASS_MODULES="$(poetry run python -c 'import webknossos; import inspect; print("|".join(i.__name__ + ":" + i.__module__ for i in webknossos.__dict__.values() if inspect.isclass(i)))')"
+export PDOC_CLASS_MODULES="$(poetry run python get_keyword_mapping.py)"
 if [ $# -eq 1 ] && [ "$1" = "--api" ]; then
     poetry run pdoc ../webknossos/webknossos ../wkcuber/wkcuber -t pdoc_templates/pure_pdoc -h 0.0.0.0 -p 8196
 else

docs/get_keyword_mapping.py

@@ -0,0 +1,12 @@
+import inspect
+
+import webknossos
+
+
+print(
+    "|".join(
+        key + ":" + value.__module__
+        for key, value in webknossos.__dict__.items()
+        if getattr(value, "__module__", "").startswith("webknossos")
+    )
+)

docs/mkdocs.yml

@@ -96,6 +96,7 @@ nav:
       - User: api/webknossos/administration/user.md
       - Project: api/webknossos/administration/project.md
       - Task: api/webknossos/administration/task.md
+    - webknossos-py/changelog.md
   - Getting Help:
     - webknossos-py/development.md
     - Community Support: https://forum.image.sc/tag/webknossos" target="_blank
@@ -104,6 +105,7 @@ nav:
   - GitHub: https://github.com/scalableminds/webknossos-libs/tree/master/webknossos" target="_blank
 - webKnossos Cuber:
   - wkcuber CLI: wkcuber/index.md
+  - wkcuber/changelog.md
   - Getting Help:
     - Community Support: https://forum.image.sc/tag/webknossos" target="_blank
     - Email Support: mailto:[email protected]