Documentation

fredkj · Feb 9, 2018 · c03b80f · c03b80f
1 parent 3274b61
commit c03b80f
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 20 deletions.
diff --git a/kamaji-api/doc/source/fabric.rst b/kamaji-api/doc/source/fabric.rst
@@ -1,22 +1,13 @@
 Fabric
 ======
 
-Views
------
-
-.. automodule:: fabric.views
-   :members:
-   :show-inheritance:
-
-Tasks
------
-
-.. automodule:: fabric.tasks
-   :members:
-   :show-inheritance:
+This package contains the Fabrics app and provides Django-style models, views and tasks
+for launching and configuring Computes complete with networks and block storage.
 
 Models
 ------
+This package contains Django-style models that allows to set up the fabric of your
+Kamaji environment.
 
 .. automodule:: fabric.models.models_credentials
    :members:
@@ -41,3 +32,24 @@ Models
 .. automodule:: fabric.models.models_storage
    :members:
    :show-inheritance:
+
+Views
+-----
+
+.. automodule:: fabric.views
+   :members:
+   :show-inheritance:
+
+Tasks
+-----
+
+.. automodule:: fabric.tasks
+   :members:
+   :show-inheritance:
+
+Validators
+----------
+
+.. automodule:: fabric.validators
+   :members:
+   :show-inheritance:
diff --git a/kamaji-api/doc/source/shared.rst b/kamaji-api/doc/source/shared.rst
@@ -12,13 +12,6 @@ Models
    :members:
    :show-inheritance:
 
-Validators
-----------
-
-.. automodule:: shared.rest_validators
-   :members:
-   :show-inheritance:
-
 Views
 -----
 
@@ -46,3 +39,10 @@ Exceptions
 .. automodule:: shared.exceptions
    :members:
    :show-inheritance:
+
+Validators
+----------
+
+.. automodule:: shared.rest_validators
+   :members:
+   :show-inheritance: