Unverified Commit fc2ff6ca authored by Kelly Guo's avatar Kelly Guo Committed by GitHub

Normalizes line endings for docs/make.bat (#3757)

# Description

When cloning the repo, make.bat caused line ending changes to be
triggered on Linux due to difference in Windows and Linux styles. This
change normalizes the script to avoid triggering git conversions when
cloning the repo.

## Type of change

- Bug fix (non-breaking change which fixes an issue)


## Checklist

- [x] I have read and understood the [contribution
guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html)
- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./isaaclab.sh --format`
- [ ] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file
- [ ] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there
parent d6a544de
@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
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment