doc+fix: Added module docstrings, removed render defaults

src/viur/core/modules/file.py

@@ -970,10 +970,6 @@ def mark_for_deletion(self, dlkey: str) -> None:
         db.Put(fileObj)
 
 
-File.json = True
-File.html = True
-
-
 @PeriodicTask(interval=datetime.timedelta(hours=4))
 def startCheckForUnreferencedBlobs():
     """

src/viur/core/modules/formmailer.py

@@ -10,6 +10,10 @@ class MailSkel(RelSkel):
 
 
 class Formmailer(Module):
+    """
+    Formmailer is the standard module to implement a form mailer for contact request or similar forms.
+    """
+
     mailTemplate = None
 
     @exposed

src/viur/core/modules/moduleconf.py

@@ -185,6 +185,3 @@ def collect_modules(parent, depth: int = 0, prefix: str = "") -> None:
 
         collect_modules(conf.main_app.vi)
         # TODO: Remove entries from MODULECONF_KINDNAME which are in db_module_names but not in ModuleConf.MODULES
-
-
-ModuleConf.json = True

src/viur/core/modules/page.py

@@ -20,6 +20,10 @@ class PageSkel(TreeSkel):
 
 
 class Page(Tree):
+    """
+    A simple page construction module, allowing to create a structure of pages.
+    """
+
     adminInfo = {
         "name": "Pages",
         "handler": "tree.nodeonly.page",
@@ -41,4 +45,3 @@ def getAvailableRootNodes(self, *args, **kwargs):
 
 
 Page.html = True
-Page.json = True

src/viur/core/modules/script.py

@@ -82,6 +82,10 @@ class ScriptLeafSkel(BaseScriptAbstractSkel):
 
 
 class Script(Tree):
+    """
+    Script is a system module used to serve a filesystem for scripts used by ViUR Scriptor and ViUR CLI.
+    """
+
     leafSkelCls = ScriptLeafSkel
     nodeSkelCls = ScriptNodeSkel
 
@@ -156,6 +160,3 @@ def update_path(self, skel):
             key = parent_skel["parententry"]
 
         skel["path"] = "/".join(path)
-
-
-Script.json = True

src/viur/core/modules/site.py

@@ -3,6 +3,13 @@
 
 
 class Site(Module):
+    """
+    The Site module simply serves static templates without a module-binding stored in html/sites.
+
+    It is normally imported as `s` module in modern ViUR projects, to serve pages under short URL.
+    Therefore, a template `html/sites/imprint.html` can be accessed via `/s/imprint` by default.
+    """
+
     adminInfo = None
 
     @exposed

src/viur/core/modules/translation.py

@@ -123,6 +123,10 @@ def preProcessSerializedData(cls, skelValues: SkeletonInstance, entity: db.Entit
 
 
 class Translation(List):
+    """
+    The Translation module is a system module used by the ViUR framework for its internationalization capabilities.
+    """
+
     kindName = KINDNAME
 
     def adminInfo(self):

src/viur/core/modules/user.py

@@ -1130,6 +1130,12 @@ def authenticator_otp(self, **kwargs):
 
 
 class User(List):
+    """
+    The User module is used to manage and authenticate users in a ViUR system.
+
+    It is used in almost any ViUR project, but ViUR can also function without any user capabilites.
+    """
+
     kindName = "user"
     addTemplate = "user_add"
     addSuccessTemplate = "user_add_success"