Skip to content

Commit

Permalink
More docs build fixes (#2030)
Browse files Browse the repository at this point in the history
* broken references in old whatsnews

* add missing ref to bishop88_* funcs

* this was interpreted as code (?)

* I think this messes up the indentation

* Fix unknown references in autosummaries

* This one too

* 🚀

* Undo calcparams_cec, I misread

* Aha, this is the right calcparams_ function

* Dammit, it's always the linter
  • Loading branch information
echedey-ls committed May 1, 2024
1 parent ad2e6ac commit 345b26f
Show file tree
Hide file tree
Showing 8 changed files with 40 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/sphinx/source/whatsnew/v0.3.0.txt
Expand Up @@ -69,7 +69,7 @@ Enhancements
* Modify ``sapm`` documentation to clarify that it does
not work with the CEC database. (:issue:`122`)
* Adds citation information to the documentation. (:issue:`73`)
* Updates the :ref:`comparison_pvlib_matlab` documentation. (:issue:`116`)
* Updates the ``comparison_pvlib_matlab`` documentation. (:issue:`116`)


Bug fixes
Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/source/whatsnew/v0.9.1.rst
Expand Up @@ -14,7 +14,7 @@ Deprecations
:py:class:`~pvlib.modelchain.ModelChain` interfaces, although note that the
inputs do not directly translate. (:pull:`1401`)
* All functionality in the ``pvlib.forecast`` module is deprecated.
For details, see :ref:`forecasts`. (:issue:`1057`, :pull:`1426`)
For details, see ``forecasts``. (:issue:`1057`, :pull:`1426`)

Enhancements
~~~~~~~~~~~~
Expand Down
3 changes: 2 additions & 1 deletion pvlib/iotools/srml.py
Expand Up @@ -175,7 +175,8 @@ def _format_index(df):
@deprecated('0.10.0', alternative='pvlib.iotools.get_srml', removal='0.11.0')
def read_srml_month_from_solardat(station, year, month, filetype='PO',
map_variables=True):
"""Request a month of SRML data and read it into a Dataframe.
"""
Request a month of SRML data and read it into a Dataframe.
The SRML is described in [1]_.
Expand Down
12 changes: 7 additions & 5 deletions pvlib/pvarray.py
Expand Up @@ -311,11 +311,13 @@ def huld(effective_irradiance, temp_mod, pdc0, k=None, cell_type=None):
:py:func:`huld` is a component of the PV performance model implemented in
PVGIS. Among other components, the full PVGIS model includes:
- the Faiman model for module temperature
:py:func:`pvlib.temperature.faiman`
- the Martin and Ruiz model for the incidence angle modifier (IAM)
:py:func:`pvlib.iam.martin_ruiz`
- a custom model for a spectral adjustment factor
- the Faiman model for module temperature
:py:func:`pvlib.temperature.faiman`
- the Martin and Ruiz model for the incidence angle modifier (IAM)
:py:func:`pvlib.iam.martin_ruiz`
- a custom model for a spectral adjustment factor
The PVGIS API (see :py:func:`pvlib.iotools.get_pvgis_hourly`) returns
broadband plane-of-array irradiance (``poa_global``) and DC power (``P``).
``poa_global`` is irradiance before applying the IAM and spectral
Expand Down
6 changes: 4 additions & 2 deletions pvlib/pvsystem.py
Expand Up @@ -1487,8 +1487,10 @@ def calcparams_desoto(effective_irradiance, temp_cell,
'''
Calculates five parameter values for the single diode equation at
effective irradiance and cell temperature using the De Soto et al.
model described in [1]_. The five values returned by calcparams_desoto
can be used by singlediode to calculate an IV curve.
model. The five values returned by ``calcparams_desoto`` can be used by
singlediode to calculate an IV curve.
The model is described in [1]_.
Parameters
----------
Expand Down
6 changes: 4 additions & 2 deletions pvlib/scaling.py
Expand Up @@ -13,8 +13,10 @@
def wvm(clearsky_index, positions, cloud_speed, dt=None):
"""
Compute spatial aggregation time series smoothing on clear sky index based
on the Wavelet Variability model of Lave et al. [1]_, [2]_. Implementation
is basically a port of the Matlab version of the code [3]_.
on the Wavelet Variability model.
This model is described in Lave et al. [1]_, [2]_.
Implementation is basically a port of the Matlab version of the code [3]_.
Parameters
----------
Expand Down
18 changes: 18 additions & 0 deletions pvlib/singlediode.py
Expand Up @@ -285,6 +285,12 @@ def bishop88_i_from_v(voltage, photocurrent, saturation_current,
>>> i, method_output = bishop88_i_from_v(0.0, **args, method='newton',
... method_kwargs={'full_output': True})
References
----------
.. [1] "Computer simulation of the effects of electrical mismatches in
photovoltaic cell interconnection circuits" JW Bishop, Solar Cell (1988)
:doi:`10.1016/0379-6787(88)90059-2`
"""
# collect args
args = (photocurrent, saturation_current,
Expand Down Expand Up @@ -417,6 +423,12 @@ def bishop88_v_from_i(current, photocurrent, saturation_current,
>>> v, method_output = bishop88_v_from_i(0.0, **args, method='newton',
... method_kwargs={'full_output': True})
References
----------
.. [1] "Computer simulation of the effects of electrical mismatches in
photovoltaic cell interconnection circuits" JW Bishop, Solar Cell (1988)
:doi:`10.1016/0379-6787(88)90059-2`
"""
# collect args
args = (photocurrent, saturation_current,
Expand Down Expand Up @@ -547,6 +559,12 @@ def bishop88_mpp(photocurrent, saturation_current, resistance_series,
>>> (i_mp, v_mp, p_mp), method_output = bishop88_mpp(**args,
... method='newton', method_kwargs={'full_output': True})
References
----------
.. [1] "Computer simulation of the effects of electrical mismatches in
photovoltaic cell interconnection circuits" JW Bishop, Solar Cell (1988)
:doi:`10.1016/0379-6787(88)90059-2`
"""
# collect args
args = (photocurrent, saturation_current,
Expand Down
4 changes: 3 additions & 1 deletion pvlib/snow.py
Expand Up @@ -222,7 +222,9 @@ def loss_townsend(snow_total, snow_events, surface_tilt, relative_humidity,
string_factor=1.0, angle_of_repose=40):
'''
Calculates monthly snow loss based on the Townsend monthly snow loss
model [1]_.
model.
This model is described in [1]_.
Parameters
----------
Expand Down

0 comments on commit 345b26f

Please sign in to comment.