Skip to content

Commit 6c666ef

Browse files
authored
Merge pull request #2422 from AppDaemon:doc-fix
more doc fixes
2 parents cee268b + 43ead87 commit 6c666ef

File tree

4 files changed

+22
-7
lines changed

4 files changed

+22
-7
lines changed

appdaemon/py.typed

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +0,0 @@
1-

doc-requirements.txt

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,8 @@ idna==3.10
6464
# yarl
6565
imagesize==1.4.1
6666
# via sphinx
67+
iniconfig==2.1.0
68+
# via pytest
6769
iso8601==2.1.0
6870
# via appdaemon (pyproject.toml)
6971
jinja2==3.1.6
@@ -90,11 +92,15 @@ myst-parser==4.0.1
9092
orderly-set==5.5.0
9193
# via deepdiff
9294
packaging==25.0
93-
# via sphinx
95+
# via
96+
# pytest
97+
# sphinx
9498
paho-mqtt==2.1.0
9599
# via appdaemon (pyproject.toml)
96100
pid==3.0.4
97101
# via appdaemon (pyproject.toml)
102+
pluggy==1.6.0
103+
# via pytest
98104
propcache==0.3.2
99105
# via
100106
# aiohttp
@@ -106,8 +112,15 @@ pydantic-core==2.27.2
106112
pygments==2.19.2
107113
# via
108114
# appdaemon (pyproject.toml)
115+
# pytest
109116
# sphinx
110117
# sphinx-tabs
118+
pytest==8.4.2
119+
# via
120+
# appdaemon (pyproject.toml)
121+
# pytest-asyncio
122+
pytest-asyncio==1.2.0
123+
# via appdaemon (pyproject.toml)
111124
python-dateutil==2.9.0.post0
112125
# via appdaemon (pyproject.toml)
113126
python-engineio==4.12.2
@@ -180,6 +193,7 @@ typing-extensions==4.15.0
180193
# anyio
181194
# pydantic
182195
# pydantic-core
196+
# pytest-asyncio
183197
# starlette
184198
urllib3==2.5.0
185199
# via requests

docs/TESTING.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,18 +68,18 @@ Reference
6868
---------
6969

7070
Startup Tests
71-
^^^^^^^^^^^^^
71+
~~~~~~~~~~~~~
7272

7373
.. autofunction:: tests.functional.test_startup.test_hello_world
7474

7575
Event Tests
76-
^^^^^^^^^^^
76+
~~~~~~~~~~~
7777

7878
.. autoclass:: tests.functional.test_event.TestEventCallback
7979
:members:
8080

8181
State Tests
82-
^^^^^^^^^^^
82+
~~~~~~~~~~~
8383

8484
.. autoclass:: tests.functional.test_state.TestStateCallback
8585
:members:

pyproject.toml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ classifiers= [
4040
"Programming Language :: Python :: 3.11",
4141
"Programming Language :: Python :: 3.12",
4242
"Programming Language :: Python :: 3.13",
43-
"Topic :: Home Automation",
43+
"Topic :: Home Automation",
4444
"Typing :: Typed",
4545
]
4646

@@ -66,12 +66,14 @@ dev = [
6666

6767
# Dependencies required to build the documentation using sphinx
6868
doc = [
69+
"myst-parser>=4.0.0",
6970
"sphinx-autobuild>=2021.3.14",
7071
"sphinx-rtd-theme>=3.0.2",
7172
"sphinx-copybutton>=0.5.2",
7273
"sphinx-tabs>=3.4.7",
7374
"pygments>=2.14",
74-
"myst-parser>=4.0.0",
75+
"pytest>=8.3.2",
76+
"pytest-asyncio>=1.0.0",
7577
]
7678

7779
# Define the main CLI script

0 commit comments

Comments
 (0)