Skip to content

Create make.bat for building sphinx docs on Windows #981

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 17, 2020
Merged

Create make.bat for building sphinx docs on Windows #981

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
70fea0f
Create make.bat
kandersolar Jun 10, 2020
1b74f53
whatsnew
kandersolar Jun 13, 2020
62ae395
Merge branch 'master' into windows_make_bat
kandersolar Jul 2, 2020
c927dff
resolve sapm2 equation name conflict
kandersolar Jul 10, 2020
abea248
Merge branch 'master' into windows_make_bat
kandersolar Jul 10, 2020
aceb6fd
Merge branch 'master' into windows_make_bat
kandersolar Jul 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions docs/sphinx/make.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build

if "%1" == "" goto help

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

:end
popd
2 changes: 2 additions & 0 deletions docs/sphinx/source/whatsnew/v0.8.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ Documentation
* Clarify units for heat loss factors in
:py:func:`pvlib.temperature.pvsyst_cell` and
:py:func:`pvlib.temperature.faiman`. (:pull:`960`)
* Add make.bat so that docs can be built on Windows without ``make`` installed.
(:issue:`978`, :pull:`981`)
* Add instructions to build the documentation. (:pull:`982`)
* Corrected key names for :py:func:`pvlib.inverter.sandia`. (:issue:`976`,
:pull:`886`)
Expand Down
4 changes: 2 additions & 2 deletions pvlib/temperature.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ def sapm_cell_from_module(module_temperature, poa_global, deltaT,
Total incident irradiance [W/m^2].

deltaT : float
Parameter :math:`\Delta T` in :eq:`sapm2` [C].
Parameter :math:`\Delta T` in :eq:`sapm2_cell_from_mod` [C].

irrad_ref : float, default 1000
Reference irradiance, parameter :math:`E_{0}` in
Expand All @@ -228,7 +228,7 @@ def sapm_cell_from_module(module_temperature, poa_global, deltaT,
The model for cell temperature :math:`T_{C}` is given by Eq. 12 in [1]_.

.. math::
:label: sapm2
:label: sapm2_cell_from_mod

T_{C} = T_{m} + \frac{E}{E_{0}} \Delta T

Expand Down