Restructuring api documentation

docs/api/client.rst

@@ -0,0 +1,7 @@
+mitel\_ommclient2.client module
+===============================
+
+.. automodule:: mitel_ommclient2.client
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/connection.rst

@@ -0,0 +1,7 @@
+mitel\_ommclient2.connection module
+===================================
+
+.. automodule:: mitel_ommclient2.connection
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/exceptions.rst

@@ -0,0 +1,7 @@
+mitel\_ommclient2.exceptions module
+===================================
+
+.. automodule:: mitel_ommclient2.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/index.rst

@@ -6,4 +6,7 @@ API Documentation
 .. toctree::
    :maxdepth: 4
 
-   mitel_ommclient2
+   client
+   connection
+   exceptions
+   messages

docs/api/messages.rst

@@ -1,53 +1,32 @@
 mitel\_ommclient2.messages package
 ==================================
 
-Submodules
-----------
-
-mitel\_ommclient2.messages.getaccount module
---------------------------------------------
+.. automodule:: mitel_ommclient2.messages
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 .. automodule:: mitel_ommclient2.messages.getaccount
    :members:
    :undoc-members:
    :show-inheritance:
 
-mitel\_ommclient2.messages.getppdev module
-------------------------------------------
-
 .. automodule:: mitel_ommclient2.messages.getppdev
    :members:
    :undoc-members:
    :show-inheritance:
 
-mitel\_ommclient2.messages.getppuser module
--------------------------------------------
-
 .. automodule:: mitel_ommclient2.messages.getppuser
   :members:
   :undoc-members:
   :show-inheritance:
 
-mitel\_ommclient2.messages.open module
---------------------------------------
-
 .. automodule:: mitel_ommclient2.messages.open
    :members:
    :undoc-members:
    :show-inheritance:
 
-mitel\_ommclient2.messages.ping module
---------------------------------------
-
 .. automodule:: mitel_ommclient2.messages.ping
    :members:
    :undoc-members:
    :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: mitel_ommclient2.messages
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/api/mitel_ommclient2.rst

@@ -1,45 +0,0 @@
-mitel\_ommclient2 package
-=========================
-
-Subpackages
------------
-
-.. toctree::
-   :maxdepth: 4
-
-   mitel_ommclient2.messages
-
-Submodules
-----------
-
-mitel\_ommclient2.client module
--------------------------------
-
-.. automodule:: mitel_ommclient2.client
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-mitel\_ommclient2.connection module
------------------------------------
-
-.. automodule:: mitel_ommclient2.connection
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-mitel\_ommclient2.exceptions module
------------------------------------
-
-.. automodule:: mitel_ommclient2.exceptions
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: mitel_ommclient2
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/index.rst

@@ -14,7 +14,7 @@ This is the documentation for mitel_ommclient2. To get started stick to the :doc
    manual/client
    manual/connection
    manual/messages
-   api/modules
+   api/index
 
 Indices and tables
 ==================