From 4757c0c051a6ca5ec851c995cf5b14128dd6a4be Mon Sep 17 00:00:00 2001
From: Tom Teichler <tom.teichler@teckids.org>
Date: Thu, 16 Jul 2020 17:10:29 +0200
Subject: [PATCH] Add documentation from core modules
---
docs/ref/core/01_checks.rst | 5 +++
docs/ref/core/02_managers.rst | 5 +++
docs/ref/core/03_mixins.rst | 5 +++
.../ref/core/{01_models.rst => 04_models.rst} | 0
docs/ref/core/05_registries.rst | 5 +++
docs/ref/core/06_search_indexes.rst | 5 +++
docs/ref/core/07_tables.rst | 5 +++
docs/ref/core/08_tasks.rst | 5 +++
docs/ref/core/09_utils.rst | 44 +++++++++++++++++++
docs/ref/core/10_views.rst | 5 +++
10 files changed, 84 insertions(+)
create mode 100644 docs/ref/core/01_checks.rst
create mode 100644 docs/ref/core/02_managers.rst
create mode 100644 docs/ref/core/03_mixins.rst
rename docs/ref/core/{01_models.rst => 04_models.rst} (100%)
create mode 100644 docs/ref/core/05_registries.rst
create mode 100644 docs/ref/core/06_search_indexes.rst
create mode 100644 docs/ref/core/07_tables.rst
create mode 100644 docs/ref/core/08_tasks.rst
create mode 100644 docs/ref/core/09_utils.rst
create mode 100644 docs/ref/core/10_views.rst
diff --git a/docs/ref/core/01_checks.rst b/docs/ref/core/01_checks.rst
new file mode 100644
index 000000000..ef096f388
--- /dev/null
+++ b/docs/ref/core/01_checks.rst
@@ -0,0 +1,5 @@
+Checks
+======
+
+.. automodule:: aleksis.core.checks
+ :members:
diff --git a/docs/ref/core/02_managers.rst b/docs/ref/core/02_managers.rst
new file mode 100644
index 000000000..1b5ae3a5f
--- /dev/null
+++ b/docs/ref/core/02_managers.rst
@@ -0,0 +1,5 @@
+Managers
+========
+
+.. automodule:: aleksis.core.managers
+ :members:
\ No newline at end of file
diff --git a/docs/ref/core/03_mixins.rst b/docs/ref/core/03_mixins.rst
new file mode 100644
index 000000000..596bbf608
--- /dev/null
+++ b/docs/ref/core/03_mixins.rst
@@ -0,0 +1,5 @@
+Mixins
+======
+
+.. automodule:: aleksis.core.mixins
+ :members:
\ No newline at end of file
diff --git a/docs/ref/core/01_models.rst b/docs/ref/core/04_models.rst
similarity index 100%
rename from docs/ref/core/01_models.rst
rename to docs/ref/core/04_models.rst
diff --git a/docs/ref/core/05_registries.rst b/docs/ref/core/05_registries.rst
new file mode 100644
index 000000000..6f3bed0ac
--- /dev/null
+++ b/docs/ref/core/05_registries.rst
@@ -0,0 +1,5 @@
+Core preference registries
+==========================
+
+.. automodule:: aleksis.core.registries
+ :members:
\ No newline at end of file
diff --git a/docs/ref/core/06_search_indexes.rst b/docs/ref/core/06_search_indexes.rst
new file mode 100644
index 000000000..ba9944ace
--- /dev/null
+++ b/docs/ref/core/06_search_indexes.rst
@@ -0,0 +1,5 @@
+Search indexes
+==============
+
+.. automodule:: aleksis.core.search_indexes
+ :members:
diff --git a/docs/ref/core/07_tables.rst b/docs/ref/core/07_tables.rst
new file mode 100644
index 000000000..c669e4737
--- /dev/null
+++ b/docs/ref/core/07_tables.rst
@@ -0,0 +1,5 @@
+Core tables
+===========
+
+.. automodule:: aleksis.core.tables
+ :members:
\ No newline at end of file
diff --git a/docs/ref/core/08_tasks.rst b/docs/ref/core/08_tasks.rst
new file mode 100644
index 000000000..76a3a430f
--- /dev/null
+++ b/docs/ref/core/08_tasks.rst
@@ -0,0 +1,5 @@
+Core Celery tasks
+=================
+
+.. automodule:: aleksis.core.tasks
+ :members:
diff --git a/docs/ref/core/09_utils.rst b/docs/ref/core/09_utils.rst
new file mode 100644
index 000000000..efec0f5c6
--- /dev/null
+++ b/docs/ref/core/09_utils.rst
@@ -0,0 +1,44 @@
+Core utillity functions
+=======================
+
+
+General helper functions in core
+---------------------------------
+ .. automodule:: aleksis.core.util.core_helpers
+ :members:
+
+Predicates for permission systemd
+---------------------------------
+.. automodule:: aleksis.core.util.predicates
+ :members:
+
+Messages
+--------
+.. automodule:: aleksis.core.util.messages
+ :members:
+
+General helper functions for models
+-----------------------------------
+.. automodule:: aleksis.core.util.model_helpers
+ :members:
+
+Helper functions for SASS
+-------------------------
+.. automodule:: aleksis.core.util.sass_helpers
+ :members:
+
+Utillity function for AlekSIS app container
+-------------------------------------------
+.. automodule:: aleksis.core.util.apps
+ :members:
+
+AlekSIS core middlewares
+------------------------
+.. automodule:: aleksis.core.util.middlewares
+ :members:
+
+Search utillity
+------------------------
+.. automodule:: aleksis.core.util.search
+ :members:
+
diff --git a/docs/ref/core/10_views.rst b/docs/ref/core/10_views.rst
new file mode 100644
index 000000000..15c111f8b
--- /dev/null
+++ b/docs/ref/core/10_views.rst
@@ -0,0 +1,5 @@
+Core views
+==========
+
+.. automodule:: aleksis.core.views
+ :members:
--
GitLab