Skip to content

Normalizes line endings for docs/make.bat #3757

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 2 commits into from
Oct 19, 2025
Merged

Normalizes line endings for docs/make.bat #3757

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f91d54a
Normalize line endings for docs/make.bat
kellyguo11 Oct 18, 2025
54750b9
Merge branch 'main' into fix/line-ending
kellyguo11 Oct 18, 2025
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
130 changes: 65 additions & 65 deletions docs/make.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,65 +1,65 @@
@ECHO OFF
pushd %~dp0
REM Command file to build Sphinx documentation
set SOURCEDIR=.
set BUILDDIR=_build
REM Check if a specific target was passed
if "%1" == "multi-docs" (
REM Check if SPHINXBUILD is set, if not default to sphinx-multiversion
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-multiversion
)
where %SPHINXBUILD% >NUL 2>NUL
if errorlevel 1 (
echo.
echo.The 'sphinx-multiversion' 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-multiversion' 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% %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
REM Copy the redirect index.html to the build directory
copy _redirect\index.html %BUILDDIR%\index.html
goto end
)
if "%1" == "current-docs" (
REM Check if SPHINXBUILD is set, if not default to sphinx-build
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
where %SPHINXBUILD% >NUL 2>NUL
if errorlevel 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.http://sphinx-doc.org/
exit /b 1
)
if exist "%BUILDDIR%\current" rmdir /s /q "%BUILDDIR%\current"
%SPHINXBUILD% -W "%SOURCEDIR%" "%BUILDDIR%\current" %SPHINXOPTS%
goto end
)
REM If no valid target is passed, show usage instructions
echo.
echo.Usage:
echo. make.bat multi-docs - To build the multi-version documentation.
echo. make.bat current-docs - To build the current documentation.
echo.
:end
popd
@ECHO OFF

pushd %~dp0

REM Command file to build Sphinx documentation

set SOURCEDIR=.
set BUILDDIR=_build

REM Check if a specific target was passed
if "%1" == "multi-docs" (
REM Check if SPHINXBUILD is set, if not default to sphinx-multiversion
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-multiversion
)
where %SPHINXBUILD% >NUL 2>NUL
if errorlevel 1 (
echo.
echo.The 'sphinx-multiversion' 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-multiversion' 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% %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

REM Copy the redirect index.html to the build directory
copy _redirect\index.html %BUILDDIR%\index.html
goto end
)

if "%1" == "current-docs" (
REM Check if SPHINXBUILD is set, if not default to sphinx-build
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
where %SPHINXBUILD% >NUL 2>NUL
if errorlevel 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.http://sphinx-doc.org/
exit /b 1
)
if exist "%BUILDDIR%\current" rmdir /s /q "%BUILDDIR%\current"
%SPHINXBUILD% -W "%SOURCEDIR%" "%BUILDDIR%\current" %SPHINXOPTS%
goto end
)

REM If no valid target is passed, show usage instructions
echo.
echo.Usage:
echo. make.bat multi-docs - To build the multi-version documentation.
echo. make.bat current-docs - To build the current documentation.
echo.

:end
popd
Loading