Refactor API documentation (#33217)

* Upgrade Sphinx to 2.4.4 * Refactor API documentation * Remove left-over * Remove Markdown from docstring * Update titels
home-assistant · Mar 25, 2020 · 2647296 · 2647296
1 parent 6d311a3
commit 2647296
Show file tree

Hide file tree

Showing 17 changed files with 592 additions and 388 deletions.
diff --git a/docs/source/api/auth.rst b/docs/source/api/auth.rst
@@ -0,0 +1,29 @@
+:mod:`homeassistant.auth`
+=========================
+
+.. automodule:: homeassistant.auth
+    :members:
+
+homeassistant.auth.auth\_store
+------------------------------
+
+.. automodule:: homeassistant.auth.auth_store
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+homeassistant.auth.const
+------------------------
+
+.. automodule:: homeassistant.auth.const
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+homeassistant.auth.models
+-------------------------
+
+.. automodule:: homeassistant.auth.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/bootstrap.rst b/docs/source/api/bootstrap.rst
@@ -1,7 +1,7 @@
 .. _bootstrap_module:
 
 :mod:`homeassistant.bootstrap`
--------------------------
+------------------------------
 
 .. automodule:: homeassistant.bootstrap
     :members:
diff --git a/docs/source/api/components.rst b/docs/source/api/components.rst
@@ -0,0 +1,170 @@
+:mod:`homeassistant.components`
+===============================
+
+air\_quality
+--------------------------------------------
+
+.. automodule:: homeassistant.components.air_quality
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+alarm\_control\_panel
+--------------------------------------------
+
+.. automodule:: homeassistant.components.alarm_control_panel
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+binary\_sensor
+--------------------------------------------
+
+.. automodule:: homeassistant.components.binary_sensor
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+camera
+---------------------------
+
+.. automodule:: homeassistant.components.camera
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+calendar
+---------------------------
+
+.. automodule:: homeassistant.components.calendar
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+climate
+---------------------------
+
+.. automodule:: homeassistant.components.climate
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+conversation
+---------------------------
+
+.. automodule:: homeassistant.components.conversation
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+cover
+---------------------------
+
+.. automodule:: homeassistant.components.cover
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+device\_tracker
+---------------------------
+
+.. automodule:: homeassistant.components.device_tracker
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+fan
+---------------------------
+
+.. automodule:: homeassistant.components.fan
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+light
+---------------------------
+
+.. automodule:: homeassistant.components.light
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+lock
+---------------------------
+
+.. automodule:: homeassistant.components.lock
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+media\_player
+---------------------------
+
+.. automodule:: homeassistant.components.media_player
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+notify
+---------------------------
+
+.. automodule:: homeassistant.components.notify
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+remote
+---------------------------
+
+.. automodule:: homeassistant.components.remote
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+switch
+---------------------------
+
+.. automodule:: homeassistant.components.switch
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+sensor
+-------------------------------------
+
+.. automodule:: homeassistant.components.sensor
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+vacuum
+-------------------------------------
+
+.. automodule:: homeassistant.components.vacuum
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+water\_heater
+-------------------------------------
+
+.. automodule:: homeassistant.components.water_heater
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+weather
+---------------------------
+
+.. automodule:: homeassistant.components.weather
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+webhook
+---------------------------
+
+.. automodule:: homeassistant.components.webhook
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/api/config_entries.rst b/docs/source/api/config_entries.rst
@@ -0,0 +1,7 @@
+.. _config_entries_module:
+
+:mod:`homeassistant.config_entries`
+-----------------------------------
+
+.. automodule:: homeassistant.config_entries
+    :members:
diff --git a/docs/source/api/core.rst b/docs/source/api/core.rst
@@ -4,35 +4,4 @@
 -------------------------
 
 .. automodule:: homeassistant.core
-
-.. autoclass:: Config
-    :members:
-
-.. autoclass:: Event
-    :members:
-
-.. autoclass:: EventBus
-    :members:
-
-.. autoclass:: HomeAssistant
-    :members:
-
-.. autoclass:: State
-    :members:
-
-.. autoclass:: StateMachine
-    :members:
-
-.. autoclass:: ServiceCall
-    :members:
-
-.. autoclass:: ServiceRegistry
-    :members:
-
-Module contents
----------------
-
-.. automodule:: homeassistant.core
-    :members:
-    :undoc-members:
-    :show-inheritance:
+    :members:
diff --git a/docs/source/api/data_entry_flow.rst b/docs/source/api/data_entry_flow.rst
@@ -0,0 +1,7 @@
+.. _data_entry_flow_module:
+
+:mod:`homeassistant.data_entry_flow`
+-----------------------------
+
+.. automodule:: homeassistant.data_entry_flow
+    :members:
diff --git a/docs/source/api/device_tracker.rst b/docs/source/api/device_tracker.rst
diff --git a/docs/source/api/entity.rst b/docs/source/api/entity.rst
diff --git a/docs/source/api/event.rst b/docs/source/api/event.rst
diff --git a/docs/source/api/exceptions.rst b/docs/source/api/exceptions.rst
@@ -0,0 +1,7 @@
+.. _exceptions_module:
+
+:mod:`homeassistant.exceptions`
+-------------------------------
+
+.. automodule:: homeassistant.exceptions
+    :members: