Updated code for better documentation

shauntarves · Apr 30, 2021 · 74b80e3 · 74b80e3
1 parent 8912f9d
commit 74b80e3
Show file tree

Hide file tree

Showing 50 changed files with 6,514 additions and 2,806 deletions.
diff --git a/docs-src/index.rst b/docs-src/index.rst
@@ -2,14 +2,14 @@
    :hidden:
 
    self
-   wyze_sdk.api.devices
-   wyze_sdk.models.devices
-   wyze_sdk.models.events
+   wyze_sdk.api
+   wyze_sdk.models
+   wyze_sdk.errors
    wyze_sdk.signature
+   wyze_sdk.logging
 
-==============================================
-Wyze SDK
-==============================================
+Getting Started with Wyze SDK
+*****************************
 
 A modern Python client for controlling Wyze devices.
 
@@ -50,7 +50,7 @@ Whether you're building a custom app, or integrating into a third-party service
 **As this repository is entirely reverse-engineered, it may break at any time. If it does, I will fix it to the best of my ability.**
 
 Installation
-************
+============
 
 This package supports Python 3.8 and higher. I recommend using `PyPI <https://pypi.python.org/pypi>`_ to install Wyze SDK
 
@@ -88,17 +88,18 @@ You can run the code this way.
    python test.py
 
 Getting Help
-************
+============
 
 If you get stuck, I'm here to help. The following are the best ways to get assistance working through your issue:
 
 - `GitHub Issue Tracker <https://github.com/shauntarves/wyze-sdk/issues>`_ for questions, feature requests, bug reports and general discussion related to this package.
 
 .. include:: metadata.rst
 
-Indices and tables
-==================
+.. only:: html 
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   Indices and Tables
+   ------------------
+
+   * :ref:`genindex`
+   * :ref:`search`
diff --git a/docs-src/metadata.rst b/docs-src/metadata.rst
@@ -5,5 +5,5 @@
 .. |github_username| replace:: shauntarves
 
 .. _Issue Tracker: http://github.com/shauntarves/wyze-sdk/issues
-.. _pull request: http://github.com/shauntarves/wyze-sdk/pulls
+.. _Pull Requests: http://github.com/shauntarves/wyze-sdk/pulls
 .. _License: https://github.com/shauntarves/wyze-sdk/blob/main/LICENSE
diff --git a/docs-src/modules.rst b/docs-src/modules.rst
diff --git a/docs-src/wyze_sdk.api.devices.rst b/docs-src/wyze_sdk.api.devices.rst
diff --git a/docs-src/wyze_sdk.api.rst b/docs-src/wyze_sdk.api.rst
@@ -1,45 +1,89 @@
-wyze\_sdk.api package
-=====================
+Web Client
+**********
 
-Subpackages
------------
+.. autoclass:: wyze_sdk.api.Client
+   :members:
+   :undoc-members:
 
-.. toctree::
-   :maxdepth: 4
+Bulbs
+=====
+.. autoclass:: wyze_sdk.api.devices.bulbs.BulbsClient
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
 
-   wyze_sdk.api.devices
+Cameras
+=======
+.. autoclass:: wyze_sdk.api.devices.cameras.CamerasClient
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
 
-Submodules
-----------
+Locks
+=====
+.. autoclass:: wyze_sdk.api.devices.locks.LocksClient
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
 
-wyze\_sdk.api.base module
--------------------------
+Plugs
+=====
+.. autoclass:: wyze_sdk.api.devices.plugs.PlugsClient
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
 
-.. automodule:: wyze_sdk.api.base
+Scales
+======
+.. autoclass:: wyze_sdk.api.devices.scales.ScalesClient
    :members:
    :undoc-members:
+   :inherited-members:
    :show-inheritance:
 
-wyze\_sdk.api.client module
----------------------------
+Sensors
+=======
 
-.. automodule:: wyze_sdk.api.client
+Contact Sensors
+---------------
+.. autoclass:: wyze_sdk.api.devices.sensors.ContactSensorsClient
    :members:
    :undoc-members:
+   :inherited-members:
    :show-inheritance:
 
-wyze\_sdk.api.events module
----------------------------
+Entry Sensors
+-------------
+.. autoclass:: wyze_sdk.api.devices.sensors.MotionSensorsClient
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
 
-.. automodule:: wyze_sdk.api.events
+Thermostats
+===========
+.. autoclass:: wyze_sdk.api.devices.thermostats.ThermostatsClient
    :members:
    :undoc-members:
+   :inherited-members:
    :show-inheritance:
 
-Module contents
----------------
+Vacuums
+=======
+.. autoclass:: wyze_sdk.api.devices.vacuums.VacuumsClient
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
 
-.. automodule:: wyze_sdk.api
+Events
+======
+.. autoclass:: wyze_sdk.api.events.EventsClient
    :members:
    :undoc-members:
+   :inherited-members:
    :show-inheritance:
diff --git a/docs-src/wyze_sdk.errors.rst b/docs-src/wyze_sdk.errors.rst
@@ -1,8 +1,8 @@
-wyze\_sdk.errors package
-========================
+Errors
+******
 
-Module contents
----------------
+wyze\_sdk.errors
+----------------
 
 .. automodule:: wyze_sdk.errors
    :members:

diff --git a/docs-src/wyze_sdk.logging.rst b/docs-src/wyze_sdk.logging.rst
@@ -0,0 +1,5 @@
+Logging
+*******
+
+.. automodule:: wyze_sdk
+   :members:
diff --git a/docs-src/wyze_sdk.models.devices.rst b/docs-src/wyze_sdk.models.devices.rst
diff --git a/docs-src/wyze_sdk.models.events.rst b/docs-src/wyze_sdk.models.events.rst