make documentation little nicer

Mirantis · Oct 13, 2017 · 8ec8018 · 8ec8018
1 parent 1ab7d84
commit 8ec8018
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 35 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -7,7 +7,7 @@ Welcome to kqueen's documentation!
 ==================================
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
    :caption: Contents:
 
    kqueen

diff --git a/docs/kqueen.blueprints.rst b/docs/kqueen.blueprints.rst
@@ -1,4 +1,4 @@
-kqueen\.blueprints package
+Flask blueprints
 ==========================
 
 Subpackages

diff --git a/docs/kqueen.provisioners.rst b/docs/kqueen.provisioners.rst
@@ -1,10 +1,10 @@
-kqueen\.provisioners package
-============================
+Provisioners
+=============
 
 Submodules
 ----------
 
-kqueen\.provisioners\.jenkins module
+JenkinsProvisioner
 ------------------------------------
 
 .. automodule:: kqueen.provisioners.jenkins

diff --git a/docs/kqueen.rst b/docs/kqueen.rst
@@ -1,75 +1,67 @@
 kqueen package
 ==============
 
-Subpackages
------------
-
-.. toctree::
-
-    kqueen.blueprints
-    kqueen.provisioners
-    kqueen.storages
 
-Submodules
-----------
+Models
+-------
 
-kqueen\.config\_dev module
---------------------------
-
-.. automodule:: kqueen.config_dev
+.. automodule:: kqueen.models
     :members:
     :undoc-members:
     :show-inheritance:
 
-kqueen\.kubeapi module
+
+Kubernetes API
 ----------------------
 
 .. automodule:: kqueen.kubeapi
     :members:
     :undoc-members:
     :show-inheritance:
 
-kqueen\.models module
+Server
 ---------------------
 
-.. automodule:: kqueen.models
+.. automodule:: kqueen.server
     :members:
     :undoc-members:
     :show-inheritance:
 
-kqueen\.helpers module
+Helpers
 -----------------------
 
 .. automodule:: kqueen.helpers
     :members:
     :undoc-members:
     :show-inheritance:
 
-
-kqueen\.serializers module
+Serializers
 --------------------------
 
 .. automodule:: kqueen.serializers
     :members:
     :undoc-members:
     :show-inheritance:
 
-kqueen\.server module
----------------------
 
-.. automodule:: kqueen.server
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-kqueen\.wrappers module
+Wrappers
 -----------------------
 
 .. automodule:: kqueen.wrappers
     :members:
     :undoc-members:
     :show-inheritance:
 
+Subpackages
+-----------
+
+.. toctree::
+
+    kqueen.blueprints
+    kqueen.provisioners
+    kqueen.storages
+
+
 
 Module contents
 ---------------

diff --git a/docs/kqueen.storages.rst b/docs/kqueen.storages.rst
@@ -1,10 +1,10 @@
-kqueen\.storages package
+Model storages
 ========================
 
 Submodules
 ----------
 
-kqueen\.storages\.etcd module
+Etcd
 -----------------------------
 
 .. automodule:: kqueen.storages.etcd