Skip to content

Restructure API Reference content to improve left sidebar #1598

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Dec 20, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
54 changes: 0 additions & 54 deletions docs/sphinx/source/reference/effects_on_pv_system_output.rst

This file was deleted.

13 changes: 13 additions & 0 deletions docs/sphinx/source/reference/effects_on_pv_system_output/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.. currentmodule:: pvlib

Effects on PV System Output
===========================

.. toctree::
:maxdepth: 2

loss-models
snow
soiling
shading
spectrum
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. currentmodule:: pvlib

Loss models
-----------

.. autosummary::
:toctree: ../generated/

pvsystem.combine_loss_factors
pvsystem.dc_ohms_from_percent
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. currentmodule:: pvlib

Shading
-------

.. autosummary::
:toctree: ../generated/

shading.masking_angle
shading.masking_angle_passias
shading.sky_diffuse_passias
12 changes: 12 additions & 0 deletions docs/sphinx/source/reference/effects_on_pv_system_output/snow.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. currentmodule:: pvlib

Snow
----

.. autosummary::
:toctree: ../generated/

snow.coverage_nrel
snow.fully_covered_nrel
snow.dc_loss_nrel
snow.loss_townsend
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. currentmodule:: pvlib

Soiling
-------

.. autosummary::
:toctree: ../generated/

soiling.hsu
soiling.kimber
Original file line number Diff line number Diff line change
@@ -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
6 changes: 3 additions & 3 deletions docs/sphinx/source/reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
71 changes: 0 additions & 71 deletions docs/sphinx/source/reference/irradiance.rst

This file was deleted.

12 changes: 12 additions & 0 deletions docs/sphinx/source/reference/irradiance/class-methods.rst
Original file line number Diff line number Diff line change
@@ -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
11 changes: 11 additions & 0 deletions docs/sphinx/source/reference/irradiance/clearness-index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. currentmodule:: pvlib

Clearness index models
----------------------

.. autosummary::
:toctree: ../generated/

irradiance.clearness_index
irradiance.clearness_index_zenith_independent
irradiance.clearsky_index
17 changes: 17 additions & 0 deletions docs/sphinx/source/reference/irradiance/components.rst
Original file line number Diff line number Diff line change
@@ -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
16 changes: 16 additions & 0 deletions docs/sphinx/source/reference/irradiance/decomposition.rst
Original file line number Diff line number Diff line change
@@ -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
13 changes: 13 additions & 0 deletions docs/sphinx/source/reference/irradiance/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.. currentmodule:: pvlib

Irradiance
==========

.. toctree::
:maxdepth: 2

class-methods
components
transposition
decomposition
clearness-index
16 changes: 16 additions & 0 deletions docs/sphinx/source/reference/irradiance/transposition.rst
Original file line number Diff line number Diff line change
@@ -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
Loading