forked from home-assistant/core
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor API documentation (home-assistant#33217)
* Upgrade Sphinx to 2.4.4 * Refactor API documentation * Remove left-over * Remove Markdown from docstring * Update titels
- Loading branch information
Showing
17 changed files
with
592 additions
and
388 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
.. _bootstrap_module: | ||
|
||
:mod:`homeassistant.bootstrap` | ||
------------------------- | ||
------------------------------ | ||
|
||
.. automodule:: homeassistant.bootstrap | ||
:members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
.. _config_entries_module: | ||
|
||
:mod:`homeassistant.config_entries` | ||
----------------------------------- | ||
|
||
.. automodule:: homeassistant.config_entries | ||
:members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
.. _data_entry_flow_module: | ||
|
||
:mod:`homeassistant.data_entry_flow` | ||
----------------------------- | ||
|
||
.. automodule:: homeassistant.data_entry_flow | ||
:members: |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
.. _exceptions_module: | ||
|
||
:mod:`homeassistant.exceptions` | ||
------------------------------- | ||
|
||
.. automodule:: homeassistant.exceptions | ||
:members: |
Oops, something went wrong.