fix: docs

bramstroker · Apr 7, 2024 · da3ec34 · da3ec34
1 parent 15600af
commit da3ec34
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 10 deletions.
diff --git a/docs/source/community/tutorials.rst b/docs/source/community/tutorials.rst
@@ -53,5 +53,4 @@ Blog posts
 - https://indomus.it/progetti/stimare-assorbimenti-e-consumi-elettrici-sulla-domotica-home-assistant-con-powercalc/ (Italian)
 
 .. note::
-
-Did you also make a Youtube video or textual tutorial please let me in discussions section and I'll happily include it here.
+    Did you also make a Youtube video or textual tutorial please let me in discussions section and I'll happily include it here.
diff --git a/docs/source/configuration/global-configuration.rst b/docs/source/configuration/global-configuration.rst
@@ -59,6 +59,7 @@ All the possible options are listed below.
 | utility_meter_tariffs         | list     | **Optional** |                         | Define different tariffs. See `HA docs <https://www.home-assistant.io/integrations/utility_meter/#tariffs>`_.                                                                                                                         |
 +-------------------------------+----------+--------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | include_non_powercalc_sensors | boolean  | **Optional** | true                    | Control whether you want to include non powercalc sensors in groups. See :doc:`/include-entities`                                                                                                                                     |
++-------------------------------+----------+--------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 Change GUI configuration service
 --------------------------------

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -38,6 +38,7 @@ Misc
    :maxdepth: 1
 
    misc/naming
+   library/library
 
 Troubleshooting
 ********************

diff --git a/docs/source/library/library.rst b/docs/source/library/library.rst
@@ -1,8 +1,8 @@
-Light model library
-===================
+Profile library
+===============
 
 The component ships with predefined power profiles for different devices.
-#TODO. link to supported models
+You can find the list of supported devices in the `supported models`_ section.
 This library will keep extending by the effort of community users.
 
 At startup powercalc will check whether any of your entities are in the library, and will provide a discovered entry for you to setup.
@@ -14,9 +14,9 @@ Also you only need to download the profiles you actually use, saving bandwidth a
 
 #TODO: maybe add option to disable remote loading
 
-For more information about the library structure, See :ref:`custom-models`.
+For more information about the library structure, See :doc:`structure`.
 
-To contribute see
+To contribute see the :doc:`measure <contributing/measure>` section.
 
 Custom models
 -------------

diff --git a/docs/source/library/protocol.rst → docs/source/library/structure.rst b/docs/source/library/protocol.rst → docs/source/library/structure.rst
diff --git a/docs/source/sensor-types/energy-sensor.rst b/docs/source/sensor-types/energy-sensor.rst
@@ -22,7 +22,7 @@ Powercalc provides a service ``powercalc.reset_energy`` which you can call to re
 You can call this service from the GUI (:guilabel:`Developer tools` -> :guilabel:`Services`) or use this in automations.
 
 Calibrating energy sensor
-~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Powercalc provides a service ``powercalc.calibrate_energy`` which you can call to set an energy sensor to a forced new value.
 This can be useful if somehow the energy sensor has an erronous value.

diff --git a/docs/source/sensor-types/group/include-entities.rst b/docs/source/sensor-types/group/include-entities.rst
@@ -158,7 +158,7 @@ You can also chain nested filter using and / or construction:
                 - wildcard: switch.pond
                 - and:
                   - domain: binary_sensor
-                  - wildcard: *swimming_pool*
+                  - wildcard: "*swimming_pool*"
 
 Exclude non powercalc sensors
 =============================

diff --git a/docs/source/strategies/playbook.rst b/docs/source/strategies/playbook.rst
@@ -32,7 +32,8 @@ Configuration options
 +---------------+--------+--------------+----------+------------------------------------------------------------------------------------------+
 | repeat        | bool   | **Optional** | false    | Set to ``true`` when you want to restart the playbook after it completes                 |
 +---------------+--------+--------------+----------+------------------------------------------------------------------------------------------+
-| state_trigger | dict   | **Optional** |          | Activate a playbook when the entity has a certain state. Mapping of state -> playbook_id |                                                      |
+| state_trigger | dict   | **Optional** |          | Activate a playbook when the entity has a certain state. Mapping of state -> playbook_id |
++---------------+--------+--------------+----------+------------------------------------------------------------------------------------------+
 
 Setup a power sensor with playbook support.
 The example below will create entity ``sensor.washing_machine_power``