Skip to content

Commit 345b26f

Browse files
authored
More docs build fixes (#2030)
* 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
1 parent ad2e6ac commit 345b26f

File tree

8 files changed

+40
-13
lines changed

8 files changed

+40
-13
lines changed

docs/sphinx/source/whatsnew/v0.3.0.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Enhancements
6969
* Modify ``sapm`` documentation to clarify that it does
7070
not work with the CEC database. (:issue:`122`)
7171
* Adds citation information to the documentation. (:issue:`73`)
72-
* Updates the :ref:`comparison_pvlib_matlab` documentation. (:issue:`116`)
72+
* Updates the ``comparison_pvlib_matlab`` documentation. (:issue:`116`)
7373

7474

7575
Bug fixes

docs/sphinx/source/whatsnew/v0.9.1.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Deprecations
1414
:py:class:`~pvlib.modelchain.ModelChain` interfaces, although note that the
1515
inputs do not directly translate. (:pull:`1401`)
1616
* All functionality in the ``pvlib.forecast`` module is deprecated.
17-
For details, see :ref:`forecasts`. (:issue:`1057`, :pull:`1426`)
17+
For details, see ``forecasts``. (:issue:`1057`, :pull:`1426`)
1818

1919
Enhancements
2020
~~~~~~~~~~~~

pvlib/iotools/srml.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,8 @@ def _format_index(df):
175175
@deprecated('0.10.0', alternative='pvlib.iotools.get_srml', removal='0.11.0')
176176
def read_srml_month_from_solardat(station, year, month, filetype='PO',
177177
map_variables=True):
178-
"""Request a month of SRML data and read it into a Dataframe.
178+
"""
179+
Request a month of SRML data and read it into a Dataframe.
179180
180181
The SRML is described in [1]_.
181182

pvlib/pvarray.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -311,11 +311,13 @@ def huld(effective_irradiance, temp_mod, pdc0, k=None, cell_type=None):
311311
312312
:py:func:`huld` is a component of the PV performance model implemented in
313313
PVGIS. Among other components, the full PVGIS model includes:
314-
- the Faiman model for module temperature
315-
:py:func:`pvlib.temperature.faiman`
316-
- the Martin and Ruiz model for the incidence angle modifier (IAM)
317-
:py:func:`pvlib.iam.martin_ruiz`
318-
- a custom model for a spectral adjustment factor
314+
315+
- the Faiman model for module temperature
316+
:py:func:`pvlib.temperature.faiman`
317+
- the Martin and Ruiz model for the incidence angle modifier (IAM)
318+
:py:func:`pvlib.iam.martin_ruiz`
319+
- a custom model for a spectral adjustment factor
320+
319321
The PVGIS API (see :py:func:`pvlib.iotools.get_pvgis_hourly`) returns
320322
broadband plane-of-array irradiance (``poa_global``) and DC power (``P``).
321323
``poa_global`` is irradiance before applying the IAM and spectral

pvlib/pvsystem.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1487,8 +1487,10 @@ def calcparams_desoto(effective_irradiance, temp_cell,
14871487
'''
14881488
Calculates five parameter values for the single diode equation at
14891489
effective irradiance and cell temperature using the De Soto et al.
1490-
model described in [1]_. The five values returned by calcparams_desoto
1491-
can be used by singlediode to calculate an IV curve.
1490+
model. The five values returned by ``calcparams_desoto`` can be used by
1491+
singlediode to calculate an IV curve.
1492+
1493+
The model is described in [1]_.
14921494
14931495
Parameters
14941496
----------

pvlib/scaling.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,10 @@
1313
def wvm(clearsky_index, positions, cloud_speed, dt=None):
1414
"""
1515
Compute spatial aggregation time series smoothing on clear sky index based
16-
on the Wavelet Variability model of Lave et al. [1]_, [2]_. Implementation
17-
is basically a port of the Matlab version of the code [3]_.
16+
on the Wavelet Variability model.
17+
18+
This model is described in Lave et al. [1]_, [2]_.
19+
Implementation is basically a port of the Matlab version of the code [3]_.
1820
1921
Parameters
2022
----------

pvlib/singlediode.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,12 @@ def bishop88_i_from_v(voltage, photocurrent, saturation_current,
285285
286286
>>> i, method_output = bishop88_i_from_v(0.0, **args, method='newton',
287287
... method_kwargs={'full_output': True})
288+
289+
References
290+
----------
291+
.. [1] "Computer simulation of the effects of electrical mismatches in
292+
photovoltaic cell interconnection circuits" JW Bishop, Solar Cell (1988)
293+
:doi:`10.1016/0379-6787(88)90059-2`
288294
"""
289295
# collect args
290296
args = (photocurrent, saturation_current,
@@ -417,6 +423,12 @@ def bishop88_v_from_i(current, photocurrent, saturation_current,
417423
418424
>>> v, method_output = bishop88_v_from_i(0.0, **args, method='newton',
419425
... method_kwargs={'full_output': True})
426+
427+
References
428+
----------
429+
.. [1] "Computer simulation of the effects of electrical mismatches in
430+
photovoltaic cell interconnection circuits" JW Bishop, Solar Cell (1988)
431+
:doi:`10.1016/0379-6787(88)90059-2`
420432
"""
421433
# collect args
422434
args = (photocurrent, saturation_current,
@@ -547,6 +559,12 @@ def bishop88_mpp(photocurrent, saturation_current, resistance_series,
547559
548560
>>> (i_mp, v_mp, p_mp), method_output = bishop88_mpp(**args,
549561
... method='newton', method_kwargs={'full_output': True})
562+
563+
References
564+
----------
565+
.. [1] "Computer simulation of the effects of electrical mismatches in
566+
photovoltaic cell interconnection circuits" JW Bishop, Solar Cell (1988)
567+
:doi:`10.1016/0379-6787(88)90059-2`
550568
"""
551569
# collect args
552570
args = (photocurrent, saturation_current,

pvlib/snow.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,9 @@ def loss_townsend(snow_total, snow_events, surface_tilt, relative_humidity,
222222
string_factor=1.0, angle_of_repose=40):
223223
'''
224224
Calculates monthly snow loss based on the Townsend monthly snow loss
225-
model [1]_.
225+
model.
226+
227+
This model is described in [1]_.
226228
227229
Parameters
228230
----------

0 commit comments

Comments
 (0)