Skip to content

Commit

Permalink
docs: fix some documentation warning
Browse files Browse the repository at this point in the history
  • Loading branch information
mion00 committed Mar 2, 2023
1 parent 3d92418 commit 4f7d430
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 14 deletions.
2 changes: 2 additions & 0 deletions docs/AD_API_REFERENCE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ by the ``get_ad_api()`` call:
These calls are documented below.

.. _AppDaemon App Creation:

App Creation
------------

Expand Down
17 changes: 4 additions & 13 deletions docs/APPGUIDE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1592,25 +1592,16 @@ need.
The parameters have the following meanings:

self
^^^^

A standard Python object reference.
A standard Python object reference.

event\_name
^^^^^^^^^^^

Name of the event that was called, e.g., ``call_service``.
Name of the event that was called, e.g., ``call_service``.

data
^^^^

Any data that the system supplied with the event as a dict.
Any data that the system supplied with the event as a dict.

kwargs
^^^^^^

A dictionary containing Zero or more user keyword arguments to be
supplied to the callback.
A dictionary containing Zero or more user keyword arguments to be supplied to the callback.

listen\_event()
~~~~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/DASHBOARD_CREATION.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Dashboard Creation
UI

Dashboard Creation
-----------------------
------------------

Dashboard configuration is simple yet very powerful. Dashboards can be
created in single files or made modular for reuse of blocks of widgets.
Expand Down
4 changes: 4 additions & 0 deletions docs/HASS_API_REFERENCE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ HASS API Reference

This page provides a list of API calls and specific information related to the HASS plugin.

.. _HASS App Creation:

App Creation
------------

Expand All @@ -16,6 +18,8 @@ To create apps based on just the AppDaemon base API, use some code like the foll
def initialize(self):
.. _HASS Reference:

Reference
---------

Expand Down
4 changes: 4 additions & 0 deletions docs/MQTT_API_REFERENCE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ MQTT API Reference

A list of API calls and information specific to the MQTT plugin.

.. _MQTT App Creation:

App Creation
------------

Expand Down Expand Up @@ -36,6 +38,8 @@ brokers can be accessed within an App, as long as they are all declared when the
configured, and using the ``namespace`` parameter. See the section on `namespaces <APPGUIDE.html#namespaces>`__
for a detailed description.

.. _MQTT Examples:

Examples
^^^^^^^^

Expand Down
2 changes: 2 additions & 0 deletions docs/WIDGETDEV.rst
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,8 @@ This is useful for static fields such as titles and simplifies the widget code s
Fields that are not required to be initialized must still be present and set to ``""``.
Again, it is possible to map values directly from the Instantiated Widget straight through to the Base Widget.

.. _HADashboard Widget Icons:

Icons
~~~~~

Expand Down

0 comments on commit 4f7d430

Please sign in to comment.