centrally defined abbreviations for units with special formatting

docs/sphinx/source/conf.py

@@ -494,3 +494,13 @@ def make_github_url(file_name):
     'make_github_url': make_github_url,
     'edit_page_url_template': '{{ make_github_url(file_name) }}',
 }
+
+# list of abbreviations for typing out units with nonstandard formatting
+rst_prolog = """
+.. |wm2| replace:: Wm⁻²
+.. |wm2nm1| replace:: Wm⁻²nm⁻¹
+.. |degc| replace:: °C
+.. |deg| replace:: °
+.. |^-1| replace:: ⁻¹
+.. |^-2| replace:: ⁻²
+"""

pvlib/irradiance.py

@@ -290,15 +290,15 @@ def get_total_irradiance(surface_tilt, surface_azimuth,
     solar_zenith : numeric
         Solar zenith angle. [degree]
     solar_azimuth : numeric
-        Solar azimuth angle. [degree]
+        Solar azimuth angle. [|deg|]
     dni : numeric
         Direct Normal Irradiance. [W/m2]
     ghi : numeric
         Global horizontal irradiance. [W/m2]
     dhi : numeric
-        Diffuse horizontal irradiance. [W/m2]
+        Diffuse horizontal irradiance. [|wm2|]
     dni_extra : numeric, optional
-        Extraterrestrial direct normal irradiance. [W/m2]
+        Extraterrestrial direct normal irradiance. [|wm2|]
     airmass : numeric, optional
         Relative airmass (not adjusted for pressure). [unitless]
     albedo : numeric, default 0.25