Restructure API Reference content to improve left sidebar (#1598)

* split pv_modeling.rst into a directory The left sidebar in pydata-sphinx-theme reflects document hierarchy, without considering in-page headers. To get those headers into the sidebar, we have to rework the document hierarchy such that the former in-page headers are now reflected in the document structure. Not ideal, but it's the only way I've found so far. * split up effects_on_output and irradiance; use top-level toctree folder * add dropped entries from merge * put back ADR entries * put back astm_e1036
pvlib · Dec 20, 2022 · 8006813 · 8006813
1 parent f5fc123
commit 8006813
Show file tree

Hide file tree

Showing 25 changed files with 382 additions and 331 deletions.
diff --git a/.gitignore b/.gitignore
@@ -40,6 +40,7 @@ pvlib/spa_c_files/spa_tester.c
 
 # generated documentation
 docs/sphinx/source/reference/generated
+docs/sphinx/source/reference/*/generated
 docs/sphinx/source/savefig
 docs/sphinx/source/gallery
 

diff --git a/docs/sphinx/source/reference/effects_on_pv_system_output.rst b/docs/sphinx/source/reference/effects_on_pv_system_output.rst
diff --git a/docs/sphinx/source/reference/effects_on_pv_system_output/index.rst b/docs/sphinx/source/reference/effects_on_pv_system_output/index.rst
@@ -0,0 +1,13 @@
+.. currentmodule:: pvlib
+
+Effects on PV System Output
+===========================
+
+.. toctree::
+   :maxdepth: 2
+
+   loss-models
+   snow
+   soiling
+   shading
+   spectrum
diff --git a/docs/sphinx/source/reference/effects_on_pv_system_output/loss-models.rst b/docs/sphinx/source/reference/effects_on_pv_system_output/loss-models.rst
@@ -0,0 +1,10 @@
+.. currentmodule:: pvlib
+
+Loss models
+-----------
+
+.. autosummary::
+   :toctree: ../generated/
+
+   pvsystem.combine_loss_factors
+   pvsystem.dc_ohms_from_percent
diff --git a/docs/sphinx/source/reference/effects_on_pv_system_output/shading.rst b/docs/sphinx/source/reference/effects_on_pv_system_output/shading.rst
@@ -0,0 +1,11 @@
+.. currentmodule:: pvlib
+
+Shading
+-------
+
+.. autosummary::
+   :toctree: ../generated/
+
+   shading.masking_angle
+   shading.masking_angle_passias
+   shading.sky_diffuse_passias
diff --git a/docs/sphinx/source/reference/effects_on_pv_system_output/snow.rst b/docs/sphinx/source/reference/effects_on_pv_system_output/snow.rst
@@ -0,0 +1,12 @@
+.. currentmodule:: pvlib
+
+Snow
+----
+
+.. autosummary::
+   :toctree: ../generated/
+
+   snow.coverage_nrel
+   snow.fully_covered_nrel
+   snow.dc_loss_nrel
+   snow.loss_townsend
diff --git a/docs/sphinx/source/reference/effects_on_pv_system_output/soiling.rst b/docs/sphinx/source/reference/effects_on_pv_system_output/soiling.rst
@@ -0,0 +1,10 @@
+.. currentmodule:: pvlib
+
+Soiling
+-------
+
+.. autosummary::
+   :toctree: ../generated/
+
+   soiling.hsu
+   soiling.kimber
diff --git a/docs/sphinx/source/reference/effects_on_pv_system_output/spectrum.rst b/docs/sphinx/source/reference/effects_on_pv_system_output/spectrum.rst
@@ -0,0 +1,12 @@
+.. currentmodule:: pvlib
+
+Spectrum
+--------
+
+.. autosummary::
+   :toctree: ../generated/
+
+   spectrum.spectrl2
+   spectrum.get_example_spectral_response
+   spectrum.get_am15g
+   spectrum.calc_spectral_mismatch_field
diff --git a/docs/sphinx/source/reference/index.rst b/docs/sphinx/source/reference/index.rst
@@ -11,9 +11,9 @@ API reference
    solarposition
    clearsky
    airmass_atmospheric
-   irradiance
-   pv_modeling
-   effects_on_pv_system_output
+   irradiance/index
+   pv_modeling/index
+   effects_on_pv_system_output/index
    tracking
    iotools
    forecasting

diff --git a/docs/sphinx/source/reference/irradiance.rst b/docs/sphinx/source/reference/irradiance.rst
diff --git a/docs/sphinx/source/reference/irradiance/class-methods.rst b/docs/sphinx/source/reference/irradiance/class-methods.rst
@@ -0,0 +1,12 @@
+.. currentmodule:: pvlib
+
+Methods for irradiance calculations
+-----------------------------------
+
+.. autosummary::
+   :toctree: ../generated/
+
+   pvsystem.PVSystem.get_irradiance
+   pvsystem.PVSystem.get_aoi
+   pvsystem.PVSystem.get_iam
+   tracking.SingleAxisTracker.get_irradiance
diff --git a/docs/sphinx/source/reference/irradiance/clearness-index.rst b/docs/sphinx/source/reference/irradiance/clearness-index.rst
@@ -0,0 +1,11 @@
+.. currentmodule:: pvlib
+
+Clearness index models
+----------------------
+
+.. autosummary::
+   :toctree: ../generated/
+
+   irradiance.clearness_index
+   irradiance.clearness_index_zenith_independent
+   irradiance.clearsky_index
diff --git a/docs/sphinx/source/reference/irradiance/components.rst b/docs/sphinx/source/reference/irradiance/components.rst
@@ -0,0 +1,17 @@
+.. currentmodule:: pvlib
+
+Decomposing and combining irradiance
+------------------------------------
+
+.. autosummary::
+   :toctree: ../generated/
+
+   irradiance.get_extra_radiation
+   irradiance.aoi
+   irradiance.aoi_projection
+   irradiance.poa_horizontal_ratio
+   irradiance.beam_component
+   irradiance.poa_components
+   irradiance.get_ground_diffuse
+   irradiance.dni
+   irradiance.complete_irradiance
diff --git a/docs/sphinx/source/reference/irradiance/decomposition.rst b/docs/sphinx/source/reference/irradiance/decomposition.rst
@@ -0,0 +1,16 @@
+.. currentmodule:: pvlib
+
+.. _dniestmodels:
+
+DNI estimation models
+---------------------
+
+.. autosummary::
+   :toctree: ../generated/
+
+   irradiance.disc
+   irradiance.dirint
+   irradiance.dirindex
+   irradiance.erbs
+   irradiance.campbell_norman
+   irradiance.gti_dirint
diff --git a/docs/sphinx/source/reference/irradiance/index.rst b/docs/sphinx/source/reference/irradiance/index.rst
@@ -0,0 +1,13 @@
+.. currentmodule:: pvlib
+
+Irradiance
+==========
+
+.. toctree::
+   :maxdepth: 2
+
+   class-methods
+   components
+   transposition
+   decomposition
+   clearness-index
diff --git a/docs/sphinx/source/reference/irradiance/transposition.rst b/docs/sphinx/source/reference/irradiance/transposition.rst
@@ -0,0 +1,16 @@
+.. currentmodule:: pvlib
+
+Transposition models
+--------------------
+
+.. autosummary::
+   :toctree: ../generated/
+
+   irradiance.get_total_irradiance
+   irradiance.get_sky_diffuse
+   irradiance.isotropic
+   irradiance.perez
+   irradiance.haydavies
+   irradiance.klucher
+   irradiance.reindl
+   irradiance.king