clerie
/
mitel_ommclient2
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Restructuring api documentation

This commit is contained in:
clerie 2022-05-01 22:43:52 +02:00
parent cf3c16c66a
commit 0e19927610
7 changed files with 30 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/api/client.rst Normal file
View File

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

7
docs/api/connection.rst Normal file
View File

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

7
docs/api/exceptions.rst Normal file
View File

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

5
docs/api/modules.rst → docs/api/index.rst
View File

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

29
docs/api/mitel_ommclient2.messages.rst → docs/api/messages.rst
View File

@ -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:

45
docs/api/mitel_ommclient2.rst
View File

@ -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:

2
docs/index.rst
View File

@ -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
==================