Skip to content

more doc fixes #2422

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
acockburn merged 4 commits into from
Sep 13, 2025
Merged

more doc fixes #2422

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5b13ec3
added pytest stuff to doc requirements for the auto build
jsl12 Sep 13, 2025
9492109
Merge remote-tracking branch 'origin/dev' into doc-fix
jsl12 Sep 13, 2025
9fe914e
linting
jsl12 Sep 13, 2025
43ead87
fixed headings
jsl12 Sep 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion appdaemon/py.typed
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +0,0 @@

16 changes: 15 additions & 1 deletion doc-requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ idna==3.10
# yarl
imagesize==1.4.1
# via sphinx
iniconfig==2.1.0
# via pytest
iso8601==2.1.0
# via appdaemon (pyproject.toml)
jinja2==3.1.6
Expand All @@ -90,11 +92,15 @@ myst-parser==4.0.1
orderly-set==5.5.0
# via deepdiff
packaging==25.0
# via sphinx
# via
# pytest
# sphinx
paho-mqtt==2.1.0
# via appdaemon (pyproject.toml)
pid==3.0.4
# via appdaemon (pyproject.toml)
pluggy==1.6.0
# via pytest
propcache==0.3.2
# via
# aiohttp
Expand All @@ -106,8 +112,15 @@ pydantic-core==2.27.2
pygments==2.19.2
# via
# appdaemon (pyproject.toml)
# pytest
# sphinx
# sphinx-tabs
pytest==8.4.2
# via
# appdaemon (pyproject.toml)
# pytest-asyncio
pytest-asyncio==1.2.0
# via appdaemon (pyproject.toml)
python-dateutil==2.9.0.post0
# via appdaemon (pyproject.toml)
python-engineio==4.12.2
Expand Down Expand Up @@ -180,6 +193,7 @@ typing-extensions==4.15.0
# anyio
# pydantic
# pydantic-core
# pytest-asyncio
# starlette
urllib3==2.5.0
# via requests
Expand Down
6 changes: 3 additions & 3 deletions docs/TESTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,18 +68,18 @@ Reference
---------

Startup Tests
^^^^^^^^^^^^^
~~~~~~~~~~~~~

.. autofunction:: tests.functional.test_startup.test_hello_world

Event Tests
^^^^^^^^^^^
~~~~~~~~~~~

.. autoclass:: tests.functional.test_event.TestEventCallback
:members:

State Tests
^^^^^^^^^^^
~~~~~~~~~~~

.. autoclass:: tests.functional.test_state.TestStateCallback
:members:
6 changes: 4 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ classifiers= [
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Topic :: Home Automation",
"Topic :: Home Automation",
"Typing :: Typed",
]

Expand All @@ -66,12 +66,14 @@ dev = [

# Dependencies required to build the documentation using sphinx
doc = [
"myst-parser>=4.0.0",
"sphinx-autobuild>=2021.3.14",
"sphinx-rtd-theme>=3.0.2",
"sphinx-copybutton>=0.5.2",
"sphinx-tabs>=3.4.7",
"pygments>=2.14",
"myst-parser>=4.0.0",
"pytest>=8.3.2",
"pytest-asyncio>=1.0.0",
]

# Define the main CLI script
Expand Down
Loading