Skip to content

Add make.bat for Windows documentation builds #872

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

Open
ShlokBagwe wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add make.bat for Windows documentation builds #872

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
db081c2
Add make.bat for Windows documentation builds
ShlokBagwe Feb 18, 2026
efe7f54
Align make.bat with standard Sphinx template
ShlokBagwe Feb 20, 2026
fbac388
Merge branch 'main' into docs-add-make.bat
ShlokBagwe Mar 23, 2026
4d44286
Merge branch 'pysal:main' into docs-add-make.bat
ShlokBagwe Mar 24, 2026
90bb738
Update make.bat
ShlokBagwe Mar 24, 2026
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
32 changes: 19 additions & 13 deletions docs/make.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,31 +5,37 @@ pushd %~dp0
REM Command file for Sphinx documentation

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

if "%1" == "" goto help
if /I "%1" == "generate-rst" goto generate-rst

%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.https://www.sphinx-doc.org/
exit /b 1
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.https://www.sphinx-doc.org/
exit /b 1
)

if "%1" == "" goto help

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

:generate-rst
echo Generating custom files...
python ..\scripts\w_g_comparison.py
goto end

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

:end
popd
popd
Loading