Merge pull request #876 from onkelandy/db_addon

db_addon: fix docu

db_addon/user_doc.rst

@@ -26,11 +26,7 @@ konfiguriert ist, wird dieses Item automatisch ermittelt. Bedeutet: Sind die Ite
 oder Kindeskinder oder Kindeskinderkinder des Items, für das das Database Attribut konfiguriert ist, wird dieses automatisch
 ermittelt.
 
-Alternativ kann mit dem Attribute "db_addon_database_item"  auch der absolute Pfad des Items angegeben werden, für das
-das Database Attribut konfiguriert ist.
-
-Bsp:
-
+Alternativ kann mit dem Attribute "db_addon_database_item"  auch der absolute Pfad des Items angegeben werden, für das das Database Attribut konfiguriert ist.
 
 .. code-block:: yaml
 
@@ -89,19 +85,16 @@ Hinweise
  - Mit dem Attribut `use_oldest_entry` kann dieses Verhalten verändert werden. Ist das Attribut gesetzt, wird, wenn für den
    Beginn der Abfragezeitraums keinen Werte vorliegen, der älteste Eintrag der Datenbank genutzt.
 
- - Für die Auswertung kann es nützlich sein, bestimmte Werte aus der Datenbank bei der Berechnung auszublenden. Hierfür stehen
-   2 Möglichkeiten zur Verfügung:
+ - Für die Auswertung kann es nützlich sein, bestimmte Werte aus der Datenbank bei der Berechnung auszublenden. Hierfür stehen 2 Möglichkeiten zur Verfügung:
+
     - Plugin-Attribut `ignore_0`: (list of strings) Bei Items, bei denen ein String aus der Liste im Pfadnamen vorkommt,
       werden 0-Werte (val_num = 0) bei Datenbankauswertungen ignoriert. Hat also das Attribut den Wert ['temp'] werden bei allen Items mit
       'temp' im Pfadnamen die 0-Werte bei der Auswertung ignoriert.
-    - Item-Attribut `db_addon_ignore_value`: (num) Dieser Wert wird bei der Abfrage bzw. Auswertung der Datenbank für diese
-      Item ignoriert.
+    - Item-Attribut `db_addon_ignore_value`: (num) Dieser Wert wird bei der Abfrage bzw. Auswertung der Datenbank für dieses Item ignoriert.
 
- - Das Plugin enthält sehr ausführliche Logginginformation. Bei unerwartetem Verhalten, den LogLevel entsprechend anpassen,
-   um mehr information zu erhalten.
+ - Das Plugin enthält sehr ausführliche Logginginformation. Bei unerwartetem Verhalten, den LogLevel entsprechend anpassen, um mehr information zu erhalten.
 
- - Berechnungen des Plugins können im WebIF unterbrochen werden. Auch das gesamte Plugin kann pausiert werden. Dies kann bei
-   starker Systembelastung nützlich sein.
+ - Berechnungen des Plugins können im WebIF unterbrochen werden. Auch das gesamte Plugin kann pausiert werden. Dies kann bei starker Systembelastung nützlich sein.
 
 
 mysql Datenbank
@@ -556,6 +549,7 @@ In den db_addon_params müssen folgenden Parameter definiert sein:
 Hier ein Beispiel:
 
 .. code-block:: yaml
+
         minmax_min_gestern:
             name: Minimaler Wert gestern
             type: num
@@ -574,6 +568,7 @@ In den db_addon_params müssen folgenden Parameter definiert sein:
 - end: integer wert
 
 .. code-block:: yaml
+
         minmax_last_21:
             type: num
             db_addon_fct: minmax_last
@@ -589,6 +584,7 @@ Berechnet einen Verbrauchswert für einen bestimmen Zeitraum:
 - end: integer wert
 
 .. code-block:: yaml
+
         verbrauch_gestern:
             type: num
             db_addon_fct: verbrauch
@@ -604,6 +600,7 @@ Berechnet einen Zählerstand für einen bestimmen Zeitpunkt:
 - start: integer wert
 
 .. code-block:: yaml
+
         zaehlerstand_gestern:
             type: num
             db_addon_fct: zaehlerstand
@@ -625,8 +622,10 @@ Es stehen Button für:
 
 bereit.
 
-Achtung: Das Auslösen einer kompletten Neuberechnung aller Items kann zu einer starken Belastung der Datenbank
-aufgrund vieler Leseanfragen führen.
+.. warning::
+
+    Das Auslösen einer kompletten Neuberechnung aller Items kann zu einer starken Belastung der Datenbank
+    aufgrund vieler Leseanfragen führen.
 
 
 db_addon Items
@@ -642,7 +641,6 @@ Das Webinterface zeigt detaillierte Informationen über die im Plugin verfügbar
 Dies dient der Maintenance bzw. Fehlersuche. Dieser Tab ist nur bei Log-Level "Debug" verfügbar.
 
 
-
 Erläuterungen zu Temperatursummen
 =================================
 
@@ -654,7 +652,7 @@ Beim Grünland wird die Wärmesumme nach Ernst und Loeper benutzt, um den Vegeta
 Dabei erfolgt die Aufsummierung der Tagesmitteltemperaturen über 0 °C, wobei der Januar mit 0.5 und der Februar mit 0.75 gewichtet wird.
 Bei einer Wärmesumme von 200 Grad ist eine Düngung angesagt.
 
-siehe: https://de.wikipedia.org/wiki/Gr%C3%BCnlandtemperatursumme
+Siehe: `Wikipedia Grünlandtemperatursumme <https://de.wikipedia.org/wiki/Gr%C3%BCnlandtemperatursumme>`_
 
 Folgende Parameter sind möglich / notwendig:
 
@@ -674,7 +672,7 @@ Je nach Fragestellung und Pflanzenart werden der Schwellenwert unterschiedlich g
 Verfügbar sind die Berechnung über 0) "einfachen Durchschnitt der Tagestemperaturen", 1) "modifizierten Durchschnitt der Tagestemperaturen"
 und 2) Anzahl der Tage, deren Mitteltempertatur oberhalb der Schwellentemperatur lag.
 
-siehe https://de.wikipedia.org/wiki/Wachstumsgradtag
+siehe `Wikipedia Wachstumsgradtag <https://de.wikipedia.org/wiki/Wachstumsgradtag>`_
 
 Folgende Parameter sind möglich / notwendig:
 
@@ -683,8 +681,7 @@ Folgende Parameter sind möglich / notwendig:
     db_addon_params: "year=current, method=1, threshold=10"
 
 - year: Jahreszahl (str oder int), für das die Berechnung ausgeführt werden soll oder "current" für aktuelles Jahr  (default: 'current')
-- method: 0-Berechnung über "einfachen Durchschnitt der Tagestemperaturen", 1-Berechnung über "modifizierten Durchschnitt (default: 0)
-der Tagestemperaturen" 2-Anzahl der Tage, mit Mitteltempertatur oberhalb Schwellentemperatur// 10, 11 Ausgabe aus Zeitserie
+- method: 0-Berechnung über "einfachen Durchschnitt der Tagestemperaturen", 1-Berechnung über "modifizierten Durchschnitt (default: 0) der Tagestemperaturen" 2-Anzahl der Tage, mit Mitteltempertatur oberhalb Schwellentemperatur// 10, 11 Ausgabe aus Zeitserie
 - threshold: Schwellentemperatur in °C (int) (default: 10)
 
 
@@ -694,7 +691,7 @@ Wärmesumme
 Die Wärmesumme soll eine Aussage über den Sommer und die Pflanzenreife liefern. Es gibt keine eindeutige Definition der Größe "Wärmesumme".
 Berechnet wird die Wärmesumme als Summe aller Tagesmitteltemperaturen über einem Schwellenwert ab dem 1.1. des Jahres.
 
-siehe https://de.wikipedia.org/wiki/W%C3%A4rmesumme
+siehe `Wikipedia Wärmesumme <https://de.wikipedia.org/wiki/W%C3%A4rmesumme>`_
 
 Folgende Parameter sind möglich / notwendig:
 
@@ -713,7 +710,7 @@ Kältesumme
 Die Kältesumme soll eine Aussage über die Härte des Winters liefern.
 Berechnet wird die Kältesumme als Summe aller negativen Tagesmitteltemperaturen ab dem 21.9. des Jahres bis 31.3. des Folgejahres.
 
-siehe https://de.wikipedia.org/wiki/K%C3%A4ltesumme
+siehe `Wikipedia Kältesumme <https://de.wikipedia.org/wiki/K%C3%A4ltesumme>`_
 
 Folgende Parameter sind möglich / notwendig: