initial test

pvlib · kandersolar · Oct 31, 2024 · Sep 29, 2024 · Sep 29, 2024 · Oct 9, 2024
commit 3ccef46a3dbeebdd61f13917865fa81eed6fbf89
diff --git a/docs/sphinx/source/user_guide/glossary.rst b/docs/sphinx/source/user_guide/glossary.rst
@@ -0,0 +1,15 @@
+.. glossary:
+
+Glossary
+========
+
+.. glossary::
+
+    dni
+        Direct Normal Irradiance [Wm⁻²]. Amount of radiation received per unit
+        area by a surface perpendicular (normal) to the sun's rays that
+        propagate in a straight line from the sun.
+
+    surface_tilt
+        Panel tilt from horizontal [°]. For example, a surface facing up = 0°,
+        surface facing horizon = 90°.
diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/index.rst
@@ -16,5 +16,6 @@ User Guide
    bifacial
    weather_data
    variables_style_rules
+   glossary
    singlediode
    faq
diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py
@@ -745,6 +745,10 @@ def haydavies(surface_tilt, surface_azimuth, dhi, dni, dni_extra,
         defined as degrees from horizontal (e.g. surface facing up = 0,
         surface facing horizon = 90)
 
+    surface_tilt : numeric
+        Panel tilt from the horizontal, in decimal degrees, see
+        :term:`surface_tilt`.
+
     surface_azimuth : numeric
         Surface azimuth angles in decimal degrees. The azimuth
         convention is defined as degrees east of north (e.g. North=0,
@@ -756,6 +760,12 @@ def haydavies(surface_tilt, surface_azimuth, dhi, dni, dni_extra,
     dni : numeric
         Direct normal irradiance. [Wm⁻²]
 
+    dni : numeric
+        Direct normal irradiance, see :term:`dni`. [Wm⁻²]
+
+    dni : numeric
+        :term:`Direct Normal Irradiance<dni>` [Wm⁻²]
+
     dni_extra : numeric
         Extraterrestrial normal irradiance. [Wm⁻²]