diff --git a/docs/api/client.rst b/docs/api/client.rst new file mode 100644 index 0000000..374986c --- /dev/null +++ b/docs/api/client.rst @@ -0,0 +1,7 @@ +mitel\_ommclient2.client module +=============================== + +.. automodule:: mitel_ommclient2.client + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/connection.rst b/docs/api/connection.rst new file mode 100644 index 0000000..477123d --- /dev/null +++ b/docs/api/connection.rst @@ -0,0 +1,7 @@ +mitel\_ommclient2.connection module +=================================== + +.. automodule:: mitel_ommclient2.connection + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/exceptions.rst b/docs/api/exceptions.rst new file mode 100644 index 0000000..a6e7777 --- /dev/null +++ b/docs/api/exceptions.rst @@ -0,0 +1,7 @@ +mitel\_ommclient2.exceptions module +=================================== + +.. automodule:: mitel_ommclient2.exceptions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/modules.rst b/docs/api/index.rst similarity index 60% rename from docs/api/modules.rst rename to docs/api/index.rst index 53ff653..4677f7f 100644 --- a/docs/api/modules.rst +++ b/docs/api/index.rst @@ -6,4 +6,7 @@ API Documentation .. toctree:: :maxdepth: 4 - mitel_ommclient2 + client + connection + exceptions + messages diff --git a/docs/api/mitel_ommclient2.messages.rst b/docs/api/messages.rst similarity index 58% rename from docs/api/mitel_ommclient2.messages.rst rename to docs/api/messages.rst index 1b20a24..7db5877 100644 --- a/docs/api/mitel_ommclient2.messages.rst +++ b/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: diff --git a/docs/api/mitel_ommclient2.rst b/docs/api/mitel_ommclient2.rst deleted file mode 100644 index 743f0c1..0000000 --- a/docs/api/mitel_ommclient2.rst +++ /dev/null @@ -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: diff --git a/docs/index.rst b/docs/index.rst index e96d314..eda3360 100644 --- a/docs/index.rst +++ b/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 ==================