Improve doc API and headings

Alignak-monitoring-contrib · Mar 8, 2018 · 15f2f78 · 15f2f78
1 parent eb70e9c
commit 15f2f78
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 14 deletions.
diff --git a/alignak_app/__init__.py b/alignak_app/__init__.py
@@ -20,18 +20,24 @@
 # along with (AlignakApp).  If not, see <http://www.gnu.org/licenses/>.
 
 """
+    Resume
+    ++++++
+
     This Python module is a desktop application, with a system tray icon, for Alignak solution.
 
     Application notify you when you have changes in your monitoring.
     You can trigger actions inside application, see status of monitored items, problems to solved
     and many other things.
 
-    Alignak-app have the following architecture:
+    Architecture
+    ++++++++++++
+
+    Alignak-app works as follows:
 
     * The :class:`BackendClient <alignak_app.backend.backend.BackendClient>` manage requests with
       Alignak backend.
-    * The :class:`ThreadManager <alignak_app.qthreads.threadmanager.ThreadManager>` will
-      launch :class:`BackendQThread(s) <alignak_app.qthreads.thread.BackendQThread>` to
+    * The :class:`ThreadManager <alignak_app.qobjects.threads.threadmanager.ThreadManager>` will
+      launch :class:`BackendQThread(s) <alignak_app.qobjects.threads.thread.BackendQThread>` to
       trigger requests in :class:`BackendClient <alignak_app.backend.backend.BackendClient>`.
     * The :class:`DataManager <alignak_app.backend.datamanager.DataManager>` will store data
       provided by :class:`BackendClient <alignak_app.backend.backend.BackendClient>` in
@@ -40,6 +46,7 @@
       :class:`DataManager <alignak_app.backend.datamanager.DataManager>`.
     * The :class:`Utils <alignak_app.utils>` package contains settings, logs, installation,...
     * The :class:`Locales <alignak_app.locales>` package contains translations.
+    * The :class:`Login <alignak_app.qobjects.login.login>` package manage user login if needed.
 
     Alignak-app will use a system of :class:`Installer <alignak_app.utils.installer.Installer>`
     who use **environment variables** to run:
@@ -48,7 +55,6 @@
     * ``ALIGNAKAPP_LOG_DIR``: contains log files of App (**write rights**)
     * ``ALIGNAKAPP_APP_DIR``: contains binaries of App (images, css, languages) (**read rights**)
 
-    The :class:`Login <alignak_app.qobjects.login.login.LoginQDialog>` manage user login if needed.
 
 """
 

diff --git a/docs/api.rst b/docs/api.rst
@@ -1,15 +1,5 @@
 .. _api:
 
-Alignak-App
-###########
-
-Architecture
-============
-
-.. automodule:: alignak_app
-    :members:
-    :show-inheritance:
-
 API
 ===
 

diff --git a/docs/archi.rst b/docs/archi.rst
@@ -0,0 +1,8 @@
+.. _archi:
+
+Architecture
+============
+
+.. automodule:: alignak_app
+    :members:
+    :show-inheritance:
diff --git a/docs/index.rst b/docs/index.rst
@@ -15,6 +15,7 @@ Documentation content:
     installer
     config
     use
+    archi
     api