Skip to content

Commit 79038f2

Browse files
authored
Fix most sphinx warnings (#912)
* fix underline in examples/plot_singlediode.py * move references out of the first sentence * pin docutils at 0.15.2 in doc requirements
1 parent c9929e8 commit 79038f2

18 files changed

+70
-42
lines changed

docs/examples/plot_singlediode.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
Calculating a module's IV curves
3-
=====================
3+
================================
44
55
Examples of modeling IV curves using a single-diode circuit equivalent model.
66
"""

pvlib/bifacial.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ def pvfactors_timeseries(
1818
"""
1919
Calculate front and back surface plane-of-array irradiance on
2020
a fixed tilt or single-axis tracker PV array configuration, and using
21-
the open-source "pvfactors" package [1]_.
21+
the open-source "pvfactors" package. pvfactors implements the model
22+
described in [1]_.
2223
Please refer to pvfactors online documentation for more details:
2324
https://sunpower.github.io/pvfactors/
2425

pvlib/clearsky.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,7 @@ def simplified_solis(apparent_elevation, aod700=0.1, precipitable_water=1.,
405405
pressure=101325., dni_extra=1364.):
406406
"""
407407
Calculate the clear sky GHI, DNI, and DHI according to the
408-
simplified Solis model [1]_.
408+
simplified Solis model.
409409
410410
Reference [1]_ describes the accuracy of the model as being 15, 20,
411411
and 18 W/m^2 for the beam, global, and diffuse components. Reference
@@ -604,7 +604,7 @@ def detect_clearsky(measured, clearsky, times, window_length,
604604
return_components=False):
605605
"""
606606
Detects clear sky times according to the algorithm developed by Reno
607-
and Hansen for GHI measurements [1]. The algorithm was designed and
607+
and Hansen for GHI measurements. The algorithm [1]_ was designed and
608608
validated for analyzing GHI time series only. Users may attempt to
609609
apply it to other types of time series data using different filter
610610
settings, but should be skeptical of the results.

pvlib/iotools/crn.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@
4242

4343
def read_crn(filename):
4444
"""
45-
Read NOAA USCRN [1]_ [2]_ fixed-width file into pandas dataframe.
45+
Read a NOAA USCRN fixed-width file into pandas dataframe. The CRN is
46+
described in [1]_ and [2]_.
4647
4748
Parameters
4849
----------

pvlib/iotools/midc.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ def format_index_raw(data):
154154

155155
def read_midc(filename, variable_map={}, raw_data=False, **kwargs):
156156
"""Read in National Renewable Energy Laboratory Measurement and
157-
Instrumentation Data Center [1]_ weather data.
157+
Instrumentation Data Center weather data. The MIDC is described in [1]_.
158158
159159
Parameters
160160
----------

pvlib/iotools/psm3.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ def get_psm3(latitude, longitude, api_key, email, names='tmy', interval=60,
2424
leap_day=False, full_name=PVLIB_PYTHON, affiliation=PVLIB_PYTHON,
2525
timeout=30):
2626
"""
27-
Retrieve NSRDB [1]_ PSM3 timeseries weather data from the PSM3 API [2]_
28-
[3]_.
27+
Retrieve NSRDB PSM3 timeseries weather data from the PSM3 API. The NSRDB
28+
is described in [1]_ and the PSM3 API is described in [2]_ and [3]_.
2929
3030
Parameters
3131
----------
@@ -147,7 +147,8 @@ def get_psm3(latitude, longitude, api_key, email, names='tmy', interval=60,
147147

148148
def parse_psm3(fbuf):
149149
"""
150-
Parse an NSRDB [1]_ PSM3 weather file (formatted as SAM CSV [2]_).
150+
Parse an NSRDB PSM3 weather file (formatted as SAM CSV). The NSRDB
151+
is described in [1]_ and the SAM CSV format is described in [2]_.
151152
152153
Parameters
153154
----------
@@ -269,7 +270,8 @@ def parse_psm3(fbuf):
269270

270271
def read_psm3(filename):
271272
"""
272-
Read an NSRDB [1]_ PSM3 weather file (formatted as SAM CSV [2]_).
273+
Read an NSRDB PSM3 weather file (formatted as SAM CSV). The NSRDB
274+
is described in [1]_ and the SAM CSV format is described in [2]_.
273275
274276
Parameters
275277
----------

pvlib/iotools/pvgis.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ def get_pvgis_tmy(lat, lon, outputformat='json', usehorizon=True,
2828
userhorizon=None, startyear=None, endyear=None, url=URL,
2929
timeout=30):
3030
"""
31-
Get TMY data from PVGIS [1]_. For more information see the PVGIS TMY tool
31+
Get TMY data from PVGIS. For more information see the PVGIS [1]_ TMY tool
3232
documentation [2]_.
3333
3434
Parameters

pvlib/iotools/solrad.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@
4949

5050
def read_solrad(filename):
5151
"""
52-
Read NOAA SOLRAD [1]_ [2]_ fixed-width file into pandas dataframe.
52+
Read NOAA SOLRAD fixed-width file into pandas dataframe. The SOLRAD
53+
network is described in [1]_ and [2]_.
5354
5455
Parameters
5556
----------

pvlib/iotools/srml.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@
2626

2727
def read_srml(filename):
2828
"""
29-
Read University of Oregon SRML[1]_ 1min .tsv file into pandas dataframe.
29+
Read University of Oregon SRML 1min .tsv file into pandas dataframe. The
30+
SRML is described in [1]_.
3031
3132
Parameters
3233
----------
@@ -166,8 +167,8 @@ def format_index(df):
166167

167168

168169
def read_srml_month_from_solardat(station, year, month, filetype='PO'):
169-
"""Request a month of SRML[1] data from solardat and read it into
170-
a Dataframe.
170+
"""Request a month of SRML data from solardat and read it into
171+
a Dataframe. The SRML is described in [1]_.
171172
172173
Parameters
173174
----------

pvlib/iotools/surfrad.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@
3838

3939

4040
def read_surfrad(filename, map_variables=True):
41-
"""Read in a daily NOAA SURFRAD[1]_ file.
41+
"""Read in a daily NOAA SURFRAD file. The SURFRAD network is
42+
described in [1]_.
4243
4344
Parameters
4445
----------

0 commit comments

Comments
 (0)