Skip to content

Commit ea0f0b2

Browse files
authored
Create make.bat for building sphinx docs on Windows (#981)
* Create make.bat * whatsnew * resolve sapm2 equation name conflict
1 parent 4380445 commit ea0f0b2

File tree

3 files changed

+39
-2
lines changed

3 files changed

+39
-2
lines changed

docs/sphinx/make.bat

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
13+
if "%1" == "" goto help
14+
15+
%SPHINXBUILD% >NUL 2>NUL
16+
if errorlevel 9009 (
17+
echo.
18+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19+
echo.installed, then set the SPHINXBUILD environment variable to point
20+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
21+
echo.may add the Sphinx directory to PATH.
22+
echo.
23+
echo.If you don't have Sphinx installed, grab it from
24+
echo.http://sphinx-doc.org/
25+
exit /b 1
26+
)
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ Documentation
4444
* Clarify units for heat loss factors in
4545
:py:func:`pvlib.temperature.pvsyst_cell` and
4646
:py:func:`pvlib.temperature.faiman`. (:pull:`960`)
47+
* Add make.bat so that docs can be built on Windows without ``make`` installed.
48+
(:issue:`978`, :pull:`981`)
4749
* Add instructions to build the documentation. (:pull:`982`)
4850
* Corrected key names for :py:func:`pvlib.inverter.sandia`. (:issue:`976`,
4951
:pull:`886`)

pvlib/temperature.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ def sapm_cell_from_module(module_temperature, poa_global, deltaT,
213213
Total incident irradiance [W/m^2].
214214
215215
deltaT : float
216-
Parameter :math:`\Delta T` in :eq:`sapm2` [C].
216+
Parameter :math:`\Delta T` in :eq:`sapm2_cell_from_mod` [C].
217217
218218
irrad_ref : float, default 1000
219219
Reference irradiance, parameter :math:`E_{0}` in
@@ -228,7 +228,7 @@ def sapm_cell_from_module(module_temperature, poa_global, deltaT,
228228
The model for cell temperature :math:`T_{C}` is given by Eq. 12 in [1]_.
229229
230230
.. math::
231-
:label: sapm2
231+
:label: sapm2_cell_from_mod
232232
233233
T_{C} = T_{m} + \frac{E}{E_{0}} \Delta T
234234

0 commit comments

Comments
 (0)