Update all doc api for new packages

Ref #263
Alignak-monitoring-contrib · Mar 7, 2018 · eb70e9c · eb70e9c
1 parent 521b5ad
commit eb70e9c
Show file tree

Hide file tree

Showing 13 changed files with 281 additions and 278 deletions.
diff --git a/alignak_app/qobjects/common/about.py → alignak_app/qobjects/about.py b/alignak_app/qobjects/common/about.py → alignak_app/qobjects/about.py
diff --git a/alignak_app/qobjects/host/__init__.py b/alignak_app/qobjects/host/__init__.py
@@ -20,5 +20,5 @@
 # along with (AlignakApp).  If not, see <http://www.gnu.org/licenses/>.
 
 """
-    The Host package contains QObjects to display data of the backend ``host``s
+    The Host package contains QObjects to display data of the backend ``host``
 """
diff --git a/alignak_app/qobjects/service/__init__.py b/alignak_app/qobjects/service/__init__.py
@@ -20,5 +20,5 @@
 # along with (AlignakApp).  If not, see <http://www.gnu.org/licenses/>.
 
 """
-    The Service package contains QObjects to display data of the backend ``service``s
+    The Service package contains QObjects to display data of the backend ``service``
 """
diff --git a/alignak_app/qobjects/systray/tray_icon.py b/alignak_app/qobjects/systray/tray_icon.py
@@ -35,7 +35,7 @@
 from alignak_app.backend.backend import app_backend
 
 from alignak_app.qobjects.app_main import AppQMainWindow
-from alignak_app.qobjects.common.about import AboutQDialog
+from alignak_app.qobjects.about import AboutQDialog
 from alignak_app.qobjects.events.events import send_event
 
 from alignak_app.qobjects.threads.threadmanager import thread_manager

diff --git a/docs/api.rst b/docs/api.rst
@@ -1,24 +1,27 @@
 .. _api:
 
-Alignak-app Architecture
-========================
+Alignak-App
+###########
+
+Architecture
+============
 
 .. automodule:: alignak_app
     :members:
     :show-inheritance:
 
-Alignak-App
-===========
+API
+===
 
 Main Class
-~~~~~~~~~~
+----------
 
 .. automodule:: alignak_app.app
     :members:
     :show-inheritance:
 
 Backend
-~~~~~~~
+-------
 
 .. automodule:: alignak_app.backend
 
@@ -33,7 +36,7 @@ Backend
     :show-inheritance:
 
 Items
-~~~~~
+-----
 
 .. automodule:: alignak_app.items
 
@@ -88,7 +91,7 @@ Items
     :show-inheritance:
 
 Utils
-~~~~~
+-----
 
 .. automodule:: alignak_app.utils
 
@@ -121,7 +124,7 @@ Utils
     :show-inheritance:
 
 Locales
-~~~~~~~
+-------
 
 .. automodule:: alignak_app.locales
 
@@ -131,90 +134,101 @@ Locales
     :show-inheritance:
 
 QObjects
-~~~~~~~~
+--------
 
 .. automodule:: alignak_app.qobjects
 
 .. automodule:: alignak_app.qobjects.app_main
     :members:
     :show-inheritance:
 
-Common
-******
-
-.. automodule:: alignak_app.qobjects.common
+.. automodule:: alignak_app.qobjects.dock
+    :members:
+    :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.common.actions
+.. automodule:: alignak_app.qobjects.panel
     :members:
     :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.common.buttons
+Alignak
+^^^^^^^
+
+.. automodule:: alignak_app.qobjects.alignak
+
+.. automodule:: alignak_app.qobjects.alignak.dashboard
     :members:
     :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.common.frames
+.. automodule:: alignak_app.qobjects.alignak.livestate
     :members:
     :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.common.labels
+.. automodule:: alignak_app.qobjects.alignak.problems
     :members:
     :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.common.widgets
+.. automodule:: alignak_app.qobjects.alignak.status
     :members:
     :show-inheritance:
 
-Dock (Rigt part)
-****************
+Common
+^^^^^^
 
-.. automodule:: alignak_app.qobjects.dock
+.. automodule:: alignak_app.qobjects.common
 
-.. automodule:: alignak_app.qobjects.dock.password
+.. automodule:: alignak_app.qobjects.common.actions
     :members:
     :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.dock.status
+.. automodule:: alignak_app.qobjects.common.buttons
     :members:
     :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.dock.token
+.. automodule:: alignak_app.qobjects.common.frames
     :members:
     :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.dock.user_notes
+.. automodule:: alignak_app.qobjects.common.labels
     :members:
     :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.dock.user_options
+.. automodule:: alignak_app.qobjects.common.widgets
     :members:
     :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.dock.buttons
-    :members:
-    :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.dock.dock
+Events
+^^^^^^
+
+.. automodule:: alignak_app.qobjects.events
+
+.. automodule:: alignak_app.qobjects.events.events
     :members:
     :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.dock.events
+.. automodule:: alignak_app.qobjects.events.item
     :members:
     :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.dock.livestate
+.. automodule:: alignak_app.qobjects.events.spy
     :members:
     :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.dock.spy
+Host
+^^^^
+
+.. automodule:: alignak_app.qobjects.host
+
+.. automodule:: alignak_app.qobjects.host.history
     :members:
     :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.dock.user
+.. automodule:: alignak_app.qobjects.host.host
     :members:
     :show-inheritance:
 
 Login
-*****
+^^^^^
 
 .. automodule:: alignak_app.qobjects.login
 
@@ -226,73 +240,77 @@ Login
     :members:
     :show-inheritance:
 
-Panel (Left part)
-*****************
+Service
+^^^^^^^
 
-.. automodule:: alignak_app.qobjects.panel
+.. automodule:: alignak_app.qobjects.service
 
-.. automodule:: alignak_app.qobjects.panel.panel
+.. automodule:: alignak_app.qobjects.service.service
     :members:
     :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.panel.dashboard
+.. automodule:: alignak_app.qobjects.service.services
     :members:
     :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.panel.history
+.. automodule:: alignak_app.qobjects.service.services_dashboard
     :members:
     :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.panel.host
+.. automodule:: alignak_app.qobjects.service.tree_item
     :members:
     :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.panel.number_services
-    :members:
-    :show-inheritance:
+Systray
+^^^^^^^
 
-.. automodule:: alignak_app.qobjects.panel.problems
-    :members:
-    :show-inheritance:
+.. automodule:: alignak_app.qobjects.systray
 
-.. automodule:: alignak_app.qobjects.panel.service
+.. automodule:: alignak_app.qobjects.systray.tray_icon
     :members:
     :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.panel.service_tree_item
+Threads
+^^^^^^^
+
+.. automodule:: alignak_app.qobjects.threads
+
+.. automodule:: alignak_app.qobjects.threads.thread
     :members:
     :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.panel.services
+.. automodule:: alignak_app.qobjects.threads.threadmanager
     :members:
     :show-inheritance:
 
-Systray
-*******
+User
+^^^^
 
-.. automodule:: alignak_app.qobjects.systray
+.. automodule:: alignak_app.qobjects.user
 
-.. automodule:: alignak_app.qobjects.systray.qactions_factory
+.. automodule:: alignak_app.qobjects.user.notes
     :members:
     :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.systray.tray_icon
+.. automodule:: alignak_app.qobjects.user.options
     :members:
     :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.systray.about
+.. automodule:: alignak_app.qobjects.user.password
     :members:
     :show-inheritance:
 
-Threads
-*******
-
-.. automodule:: alignak_app.qobjects.threads
+.. automodule:: alignak_app.qobjects.user.profile
+    :members:
+    :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.threads.thread
+.. automodule:: alignak_app.qobjects.user.token
     :members:
     :show-inheritance:
 
-.. automodule:: alignak_app.qobjects.threads.threadmanager
+About
+-----
+
+.. automodule:: alignak_app.qobjects.about
     :members:
     :show-inheritance:
diff --git a/docs/config.rst b/docs/config.rst
@@ -1,7 +1,10 @@
 .. _config:
 
+Configuration
+#############
+
 Environment Variables
-=====================
+*********************
 
 During installation, Alignak-app creates some folders that contains all the files application need to run.
 Then she will keep them in **environment variables**.
@@ -15,7 +18,7 @@ The application will normally automatically detect the folders used by the appli
 During Windows installation, if you used **Installer**, these variables are automatically filled.
 
 On Linux
---------
+========
 
 Alignak-app will try to create ``ALIGNAKAPP_USR_DIR`` for later configurations. By default this folder should be::
 
@@ -27,7 +30,7 @@ The ``ALIGNAKAPP_APP_DIR`` should be under one of the following folders and is c
     /usr/local/alignak_app/
 
 On Windows
-----------
+==========
 
 On Windows, use **Installer** is recommended (see :ref:`installer`) to respect Windows conventions.
 ``ALIGNAKAPP_USR_DIR`` and ``ALIGNAKAPP_APP_DIR`` variables are by default set to::
@@ -39,8 +42,8 @@ And ``ALIGNAKAPP_USR_DIR`` and ``ALIGNAKAPP_APP_DIR`` variables should be by def
 
     C:\Users\user\AppData\Roaming\Python\alignak_app\
 
-Configuration
-=============
+Settings File
+*************
 
 Before running application, **you must configure it**.
 
@@ -53,15 +56,8 @@ The most significant Section is **[Alignak]**. You'll need set your backend url
 
 **To Know:** Without connection on Backend of Alignak, App won't start ! "
 
-Settings file
--------------
-
-Here is the full ``settings.cfg`` file. This file contains comments for each setting.
-
-    .. literalinclude:: ../etc/settings.cfg
-
 Connection to Backend
----------------------
+=====================
 
 Alignak-app have a login form by default, who let you to connect with the username and password define in backend.
 
@@ -84,4 +80,11 @@ To obtain a token, open a python terminal and type the following commands::
     )
     print(r.text)
 
-You can also visit: `Alignak-backend : Get Token <http://docs.alignak.net/projects/alignak-backend/en/latest/api.html#get-the-authentication-token>`_
+You can also visit: `Alignak-backend : Get Token <http://docs.alignak.net/projects/alignak-backend/en/latest/api.html#get-the-authentication-token>`_
+
+File Example
+============
+
+Here is the full ``settings.cfg`` file. This file contains comments for each setting.
+
+    .. literalinclude:: ../etc/settings.cfg