Skip to content

Commit 6c857ae

Browse files
authored
Fix broken internal sphinx references (#1288)
* fix various broken internal references * undo accidental change * stickler * "not controversial" but not correct either. pvlib.tmy -> pvlib.iotools
1 parent cdb0b12 commit 6c857ae

File tree

4 files changed

+13
-12
lines changed

4 files changed

+13
-12
lines changed

docs/sphinx/source/timetimezones.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ Let's first examine how pvlib handles time when it imports a TMY3 file.
278278
279279
The metadata has a ``'TZ'`` key with a value of ``-9.0``. This is the
280280
UTC offset in hours in which the data has been recorded. The
281-
:py:func:`~pvlib.tmy.readtmy3` function read the data in the file,
281+
:py:func:`~pvlib.iotools.read_tmy3` function read the data in the file,
282282
created a :py:class:`~pandas.DataFrame` with that data, and then
283283
localized the DataFrame's index to have this fixed offset. Here, we
284284
print just a few of the rows and columns of the large dataframe.
@@ -289,7 +289,7 @@ print just a few of the rows and columns of the large dataframe.
289289
290290
tmy3_data.loc[tmy3_data.index[0:3], ['GHI', 'DNI', 'AOD']]
291291
292-
The :py:func:`~pvlib.tmy.readtmy2` function also returns a DataFrame
292+
The :py:func:`~pvlib.iotools.read_tmy2` function also returns a DataFrame
293293
with a localized DatetimeIndex.
294294

295295
Solar position

pvlib/ivtools/sde.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ def fit_sandia_simple(voltage, current, v_oc=None, i_sc=None, v_mp_i_mp=None,
9090
I = I_{L} - I_{0} (\exp \frac{V + I R_{s}}{nNsVth} - 1)
9191
- \frac{V + I R_{s}}{R_{sh}}
9292
93-
See :py:func:`pvsystem.singlediode` for definition of the parameters.
93+
See :py:func:`pvlib.pvsystem.singlediode` for definition of the parameters.
9494
9595
The extraction method [2]_ proceeds in six steps.
9696

pvlib/location.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ def from_epw(cls, metadata, data=None, **kwargs):
164164
def get_solarposition(self, times, pressure=None, temperature=12,
165165
**kwargs):
166166
"""
167-
Uses the :py:func:`solarposition.get_solarposition` function
167+
Uses the :py:func:`pvlib.solarposition.get_solarposition` function
168168
to calculate the solar zenith, azimuth, etc. at this location.
169169
170170
Parameters
@@ -173,11 +173,11 @@ def get_solarposition(self, times, pressure=None, temperature=12,
173173
Must be localized or UTC will be assumed.
174174
pressure : None, float, or array-like, default None
175175
If None, pressure will be calculated using
176-
:py:func:`atmosphere.alt2pres` and ``self.altitude``.
176+
:py:func:`pvlib.atmosphere.alt2pres` and ``self.altitude``.
177177
temperature : None, float, or array-like, default 12
178178
179179
kwargs
180-
passed to :py:func:`solarposition.get_solarposition`
180+
passed to :py:func:`pvlib.solarposition.get_solarposition`
181181
182182
Returns
183183
-------

pvlib/pvsystem.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -627,7 +627,7 @@ def sapm(self, effective_irradiance, temp_cell):
627627
@deprecated('0.9', alternative='PVSystem.get_cell_temperature',
628628
removal='0.10.0')
629629
def sapm_celltemp(self, poa_global, temp_air, wind_speed):
630-
"""Uses :py:func:`temperature.sapm_cell` to calculate cell
630+
"""Uses :py:func:`pvlib.temperature.sapm_cell` to calculate cell
631631
temperatures.
632632
633633
Parameters
@@ -720,7 +720,7 @@ def sapm_effective_irradiance(self, poa_direct, poa_diffuse,
720720
@deprecated('0.9', alternative='PVSystem.get_cell_temperature',
721721
removal='0.10.0')
722722
def pvsyst_celltemp(self, poa_global, temp_air, wind_speed=1.0):
723-
"""Uses :py:func:`temperature.pvsyst_cell` to calculate cell
723+
"""Uses :py:func:`pvlib.temperature.pvsyst_cell` to calculate cell
724724
temperature.
725725
726726
Parameters
@@ -756,7 +756,7 @@ def pvsyst_celltemp(self, poa_global, temp_air, wind_speed=1.0):
756756
removal='0.10.0')
757757
def faiman_celltemp(self, poa_global, temp_air, wind_speed=1.0):
758758
"""
759-
Use :py:func:`temperature.faiman` to calculate cell temperature.
759+
Use :py:func:`pvlib.temperature.faiman` to calculate cell temperature.
760760
761761
Parameters
762762
----------
@@ -791,7 +791,7 @@ def faiman_celltemp(self, poa_global, temp_air, wind_speed=1.0):
791791
removal='0.10.0')
792792
def fuentes_celltemp(self, poa_global, temp_air, wind_speed):
793793
"""
794-
Use :py:func:`temperature.fuentes` to calculate cell temperature.
794+
Use :py:func:`pvlib.temperature.fuentes` to calculate cell temperature.
795795
796796
Parameters
797797
----------
@@ -834,7 +834,8 @@ def fuentes_celltemp(self, poa_global, temp_air, wind_speed):
834834
def noct_sam_celltemp(self, poa_global, temp_air, wind_speed,
835835
effective_irradiance=None):
836836
"""
837-
Use :py:func:`temperature.noct_sam` to calculate cell temperature.
837+
Use :py:func:`pvlib.temperature.noct_sam` to calculate cell
838+
temperature.
838839
839840
Parameters
840841
----------
@@ -871,7 +872,7 @@ def noct_sam_celltemp(self, poa_global, temp_air, wind_speed,
871872
@_unwrap_single_value
872873
def first_solar_spectral_loss(self, pw, airmass_absolute):
873874
"""
874-
Use the :py:func:`first_solar_spectral_correction` function to
875+
Use :py:func:`pvlib.atmosphere.first_solar_spectral_correction` to
875876
calculate the spectral loss modifier. The model coefficients are
876877
specific to the module's cell type, and are determined by searching
877878
for one of the following keys in self.module_parameters (in order):

0 commit comments

Comments
 (0)