Skip to content

Commit 8006813

Browse files
kandersolarkandersolar
authored
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
1 parent f5fc123 commit 8006813

25 files changed

+382
-331
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ pvlib/spa_c_files/spa_tester.c
4040

4141
# generated documentation
4242
docs/sphinx/source/reference/generated
43+
docs/sphinx/source/reference/*/generated
4344
docs/sphinx/source/savefig
4445
docs/sphinx/source/gallery
4546

‎docs/sphinx/source/reference/effects_on_pv_system_output.rst

Lines changed: 0 additions & 54 deletions
This file was deleted.

‎docs/sphinx/source/reference/effects_on_pv_system_output/index.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. currentmodule:: pvlib
2+
3+
Effects on PV System Output
4+
===========================
5+
6+
.. toctree::
7+
:maxdepth: 2
8+
9+
loss-models
10+
snow
11+
soiling
12+
shading
13+
spectrum

‎docs/sphinx/source/reference/effects_on_pv_system_output/loss-models.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. currentmodule:: pvlib
2+
3+
Loss models
4+
-----------
5+
6+
.. autosummary::
7+
:toctree: ../generated/
8+
9+
pvsystem.combine_loss_factors
10+
pvsystem.dc_ohms_from_percent

‎docs/sphinx/source/reference/effects_on_pv_system_output/shading.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. currentmodule:: pvlib
2+
3+
Shading
4+
-------
5+
6+
.. autosummary::
7+
:toctree: ../generated/
8+
9+
shading.masking_angle
10+
shading.masking_angle_passias
11+
shading.sky_diffuse_passias

‎docs/sphinx/source/reference/effects_on_pv_system_output/snow.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. currentmodule:: pvlib
2+
3+
Snow
4+
----
5+
6+
.. autosummary::
7+
:toctree: ../generated/
8+
9+
snow.coverage_nrel
10+
snow.fully_covered_nrel
11+
snow.dc_loss_nrel
12+
snow.loss_townsend

‎docs/sphinx/source/reference/effects_on_pv_system_output/soiling.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. currentmodule:: pvlib
2+
3+
Soiling
4+
-------
5+
6+
.. autosummary::
7+
:toctree: ../generated/
8+
9+
soiling.hsu
10+
soiling.kimber

‎docs/sphinx/source/reference/effects_on_pv_system_output/spectrum.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. currentmodule:: pvlib
2+
3+
Spectrum
4+
--------
5+
6+
.. autosummary::
7+
:toctree: ../generated/
8+
9+
spectrum.spectrl2
10+
spectrum.get_example_spectral_response
11+
spectrum.get_am15g
12+
spectrum.calc_spectral_mismatch_field

‎docs/sphinx/source/reference/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ API reference
1111
solarposition
1212
clearsky
1313
airmass_atmospheric
14-
irradiance
15-
pv_modeling
16-
effects_on_pv_system_output
14+
irradiance/index
15+
pv_modeling/index
16+
effects_on_pv_system_output/index
1717
tracking
1818
iotools
1919
forecasting

‎docs/sphinx/source/reference/irradiance.rst

Lines changed: 0 additions & 71 deletions
This file was deleted.

‎docs/sphinx/source/reference/irradiance/class-methods.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. currentmodule:: pvlib
2+
3+
Methods for irradiance calculations
4+
-----------------------------------
5+
6+
.. autosummary::
7+
:toctree: ../generated/
8+
9+
pvsystem.PVSystem.get_irradiance
10+
pvsystem.PVSystem.get_aoi
11+
pvsystem.PVSystem.get_iam
12+
tracking.SingleAxisTracker.get_irradiance

‎docs/sphinx/source/reference/irradiance/clearness-index.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. currentmodule:: pvlib
2+
3+
Clearness index models
4+
----------------------
5+
6+
.. autosummary::
7+
:toctree: ../generated/
8+
9+
irradiance.clearness_index
10+
irradiance.clearness_index_zenith_independent
11+
irradiance.clearsky_index

‎docs/sphinx/source/reference/irradiance/components.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.. currentmodule:: pvlib
2+
3+
Decomposing and combining irradiance
4+
------------------------------------
5+
6+
.. autosummary::
7+
:toctree: ../generated/
8+
9+
irradiance.get_extra_radiation
10+
irradiance.aoi
11+
irradiance.aoi_projection
12+
irradiance.poa_horizontal_ratio
13+
irradiance.beam_component
14+
irradiance.poa_components
15+
irradiance.get_ground_diffuse
16+
irradiance.dni
17+
irradiance.complete_irradiance

‎docs/sphinx/source/reference/irradiance/decomposition.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. currentmodule:: pvlib
2+
3+
.. _dniestmodels:
4+
5+
DNI estimation models
6+
---------------------
7+
8+
.. autosummary::
9+
:toctree: ../generated/
10+
11+
irradiance.disc
12+
irradiance.dirint
13+
irradiance.dirindex
14+
irradiance.erbs
15+
irradiance.campbell_norman
16+
irradiance.gti_dirint

‎docs/sphinx/source/reference/irradiance/index.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. currentmodule:: pvlib
2+
3+
Irradiance
4+
==========
5+
6+
.. toctree::
7+
:maxdepth: 2
8+
9+
class-methods
10+
components
11+
transposition
12+
decomposition
13+
clearness-index

‎docs/sphinx/source/reference/irradiance/transposition.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. currentmodule:: pvlib
2+
3+
Transposition models
4+
--------------------
5+
6+
.. autosummary::
7+
:toctree: ../generated/
8+
9+
irradiance.get_total_irradiance
10+
irradiance.get_sky_diffuse
11+
irradiance.isotropic
12+
irradiance.perez
13+
irradiance.haydavies
14+
irradiance.klucher
15+
irradiance.reindl
16+
irradiance.king

0 commit comments

Comments
 (0)