Skip to content

Commit 2647296

Browse files
fabafffabaff
authored
Refactor API documentation (home-assistant#33217)
* Upgrade Sphinx to 2.4.4 * Refactor API documentation * Remove left-over * Remove Markdown from docstring * Update titels
1 parent 6d311a3 commit 2647296

17 files changed

+592
-388
lines changed

‎docs/source/api/auth.rst

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
:mod:`homeassistant.auth`
2+
=========================
3+
4+
.. automodule:: homeassistant.auth
5+
:members:
6+
7+
homeassistant.auth.auth\_store
8+
------------------------------
9+
10+
.. automodule:: homeassistant.auth.auth_store
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
homeassistant.auth.const
16+
------------------------
17+
18+
.. automodule:: homeassistant.auth.const
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
homeassistant.auth.models
24+
-------------------------
25+
26+
.. automodule:: homeassistant.auth.models
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:

‎docs/source/api/bootstrap.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _bootstrap_module:
22

33
:mod:`homeassistant.bootstrap`
4-
-------------------------
4+
------------------------------
55

66
.. automodule:: homeassistant.bootstrap
77
:members:

‎docs/source/api/components.rst

+170
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
:mod:`homeassistant.components`
2+
===============================
3+
4+
air\_quality
5+
--------------------------------------------
6+
7+
.. automodule:: homeassistant.components.air_quality
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:
11+
12+
alarm\_control\_panel
13+
--------------------------------------------
14+
15+
.. automodule:: homeassistant.components.alarm_control_panel
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
binary\_sensor
21+
--------------------------------------------
22+
23+
.. automodule:: homeassistant.components.binary_sensor
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
camera
29+
---------------------------
30+
31+
.. automodule:: homeassistant.components.camera
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
36+
calendar
37+
---------------------------
38+
39+
.. automodule:: homeassistant.components.calendar
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
43+
44+
climate
45+
---------------------------
46+
47+
.. automodule:: homeassistant.components.climate
48+
:members:
49+
:undoc-members:
50+
:show-inheritance:
51+
52+
conversation
53+
---------------------------
54+
55+
.. automodule:: homeassistant.components.conversation
56+
:members:
57+
:undoc-members:
58+
:show-inheritance:
59+
60+
cover
61+
---------------------------
62+
63+
.. automodule:: homeassistant.components.cover
64+
:members:
65+
:undoc-members:
66+
:show-inheritance:
67+
68+
device\_tracker
69+
---------------------------
70+
71+
.. automodule:: homeassistant.components.device_tracker
72+
:members:
73+
:undoc-members:
74+
:show-inheritance:
75+
76+
fan
77+
---------------------------
78+
79+
.. automodule:: homeassistant.components.fan
80+
:members:
81+
:undoc-members:
82+
:show-inheritance:
83+
84+
light
85+
---------------------------
86+
87+
.. automodule:: homeassistant.components.light
88+
:members:
89+
:undoc-members:
90+
:show-inheritance:
91+
92+
lock
93+
---------------------------
94+
95+
.. automodule:: homeassistant.components.lock
96+
:members:
97+
:undoc-members:
98+
:show-inheritance:
99+
100+
media\_player
101+
---------------------------
102+
103+
.. automodule:: homeassistant.components.media_player
104+
:members:
105+
:undoc-members:
106+
:show-inheritance:
107+
108+
notify
109+
---------------------------
110+
111+
.. automodule:: homeassistant.components.notify
112+
:members:
113+
:undoc-members:
114+
:show-inheritance:
115+
116+
remote
117+
---------------------------
118+
119+
.. automodule:: homeassistant.components.remote
120+
:members:
121+
:undoc-members:
122+
:show-inheritance:
123+
124+
switch
125+
---------------------------
126+
127+
.. automodule:: homeassistant.components.switch
128+
:members:
129+
:undoc-members:
130+
:show-inheritance:
131+
132+
sensor
133+
-------------------------------------
134+
135+
.. automodule:: homeassistant.components.sensor
136+
:members:
137+
:undoc-members:
138+
:show-inheritance:
139+
140+
vacuum
141+
-------------------------------------
142+
143+
.. automodule:: homeassistant.components.vacuum
144+
:members:
145+
:undoc-members:
146+
:show-inheritance:
147+
148+
water\_heater
149+
-------------------------------------
150+
151+
.. automodule:: homeassistant.components.water_heater
152+
:members:
153+
:undoc-members:
154+
:show-inheritance:
155+
156+
weather
157+
---------------------------
158+
159+
.. automodule:: homeassistant.components.weather
160+
:members:
161+
:undoc-members:
162+
:show-inheritance:
163+
164+
webhook
165+
---------------------------
166+
167+
.. automodule:: homeassistant.components.webhook
168+
:members:
169+
:undoc-members:
170+
:show-inheritance:

‎docs/source/api/config_entries.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. _config_entries_module:
2+
3+
:mod:`homeassistant.config_entries`
4+
-----------------------------------
5+
6+
.. automodule:: homeassistant.config_entries
7+
:members:

‎docs/source/api/core.rst

+1-32
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,4 @@
44
-------------------------
55

66
.. automodule:: homeassistant.core
7-
8-
.. autoclass:: Config
9-
:members:
10-
11-
.. autoclass:: Event
12-
:members:
13-
14-
.. autoclass:: EventBus
15-
:members:
16-
17-
.. autoclass:: HomeAssistant
18-
:members:
19-
20-
.. autoclass:: State
21-
:members:
22-
23-
.. autoclass:: StateMachine
24-
:members:
25-
26-
.. autoclass:: ServiceCall
27-
:members:
28-
29-
.. autoclass:: ServiceRegistry
30-
:members:
31-
32-
Module contents
33-
---------------
34-
35-
.. automodule:: homeassistant.core
36-
:members:
37-
:undoc-members:
38-
:show-inheritance:
7+
:members:

‎docs/source/api/data_entry_flow.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. _data_entry_flow_module:
2+
3+
:mod:`homeassistant.data_entry_flow`
4+
-----------------------------
5+
6+
.. automodule:: homeassistant.data_entry_flow
7+
:members:

‎docs/source/api/device_tracker.rst

-10
This file was deleted.

‎docs/source/api/entity.rst

-12
This file was deleted.

‎docs/source/api/event.rst

-20
This file was deleted.

‎docs/source/api/exceptions.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. _exceptions_module:
2+
3+
:mod:`homeassistant.exceptions`
4+
-------------------------------
5+
6+
.. automodule:: homeassistant.exceptions
7+
:members:

0 commit comments

Comments
 (0)