mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-05-04 00:50:40 +00:00
baldurk
f9b78a9312
* This version contains the fix for sphinx-doc/sphinx#2550 so we want to assume it is present and tidy up all the external links. However if needed (and you don't care about the external links being broken) you can locally remove this version requirement.
302 lines
8.3 KiB
Batchfile
302 lines
8.3 KiB
Batchfile
@ECHO OFF
|
|
|
|
REM Command file for Sphinx documentation
|
|
|
|
setlocal
|
|
|
|
if "%SPHINXBUILD%" == "" (
|
|
set SPHINXBUILD=sphinx-build
|
|
)
|
|
if "%HHCBUILD%" == "" (
|
|
set "HHCBUILD=C:\Program Files (x86)\HTML Help Workshop\hhc.exe"
|
|
)
|
|
set BUILDDIR=..\Documentation
|
|
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
|
|
set I18NSPHINXOPTS=%SPHINXOPTS% .
|
|
if NOT "%PAPER%" == "" (
|
|
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
|
|
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
|
|
)
|
|
|
|
if "%1" == "" goto help
|
|
|
|
if "%1" == "help" (
|
|
:help
|
|
echo.Please use `make ^<target^>` where ^<target^> is one of
|
|
echo. html to make standalone HTML files
|
|
echo. dirhtml to make HTML files named index.html in directories
|
|
echo. singlehtml to make a single large HTML file
|
|
echo. pickle to make pickle files
|
|
echo. json to make JSON files
|
|
echo. htmlhelp to make HTML files and a HTML help project
|
|
echo. qthelp to make HTML files and a qthelp project
|
|
echo. devhelp to make HTML files and a Devhelp project
|
|
echo. epub to make an epub
|
|
echo. epub3 to make an epub3
|
|
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
|
|
echo. text to make text files
|
|
echo. man to make manual pages
|
|
echo. texinfo to make Texinfo files
|
|
echo. gettext to make PO message catalogs
|
|
echo. changes to make an overview over all changed/added/deprecated items
|
|
echo. xml to make Docutils-native XML files
|
|
echo. pseudoxml to make pseudoxml-XML files for display purposes
|
|
echo. linkcheck to check all external links for integrity
|
|
echo. doctest to run all doctests embedded in the documentation if enabled
|
|
echo. coverage to run coverage check of the documentation if enabled
|
|
echo. dummy to check syntax errors of document sources
|
|
goto end
|
|
)
|
|
|
|
if "%1" == "clean" (
|
|
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
|
|
del /q /s %BUILDDIR%\*
|
|
goto end
|
|
)
|
|
|
|
|
|
REM Check if sphinx-build is available and fallback to Python version if any
|
|
%SPHINXBUILD% 1>NUL 2>NUL
|
|
if errorlevel 9009 goto sphinx_python
|
|
goto sphinx_ok
|
|
|
|
:sphinx_python
|
|
|
|
set SPHINXBUILD=python -m sphinx.__init__
|
|
%SPHINXBUILD% 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
|
|
)
|
|
|
|
:sphinx_ok
|
|
|
|
|
|
if "%1" == "html" (
|
|
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
|
|
if errorlevel 1 exit /b 1
|
|
echo.
|
|
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
|
|
goto end
|
|
)
|
|
|
|
if "%1" == "dirhtml" (
|
|
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
|
|
if errorlevel 1 exit /b 1
|
|
echo.
|
|
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
|
|
goto end
|
|
)
|
|
|
|
if "%1" == "singlehtml" (
|
|
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
|
|
if errorlevel 1 exit /b 1
|
|
echo.
|
|
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
|
|
goto end
|
|
)
|
|
|
|
if "%1" == "pickle" (
|
|
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
|
|
if errorlevel 1 exit /b 1
|
|
echo.
|
|
echo.Build finished; now you can process the pickle files.
|
|
goto end
|
|
)
|
|
|
|
if "%1" == "json" (
|
|
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
|
|
if errorlevel 1 exit /b 1
|
|
echo.
|
|
echo.Build finished; now you can process the JSON files.
|
|
goto end
|
|
)
|
|
|
|
if "%1" == "htmlhelp" (
|
|
%SPHINXBUILD% -b htmlhelp -t htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
|
|
if errorlevel 1 exit /b 1
|
|
REM Copy handwritten index file to output, overwriting auto-generated one
|
|
copy renderdoc.hhk %BUILDDIR%\htmlhelp\
|
|
REM Copy introduction page over index.html
|
|
copy %BUILDDIR%\htmlhelp\introduction.html %BUILDDIR%\htmlhelp\index.html
|
|
REM Filter out the auto-generated TOC to remove anchor links and root index.html
|
|
type %BUILDDIR%\htmlhelp\renderdoc.hhc | python remove_lines.py ".html#" | python remove_lines.py "\"index.html\"" > %BUILDDIR%\htmlhelp\tmp
|
|
move %BUILDDIR%\htmlhelp\tmp %BUILDDIR%\htmlhelp\renderdoc.hhc
|
|
if NOT "%HHCBUILD%" == "" (
|
|
"%HHCBUILD%" %BUILDDIR%\htmlhelp\renderdoc.hhp
|
|
echo.Build finished.
|
|
goto end
|
|
)
|
|
echo.
|
|
echo.Build finished; now you can run HTML Help Workshop with the ^
|
|
.hhp project file in %BUILDDIR%/htmlhelp.
|
|
echo.For future, you can either install HTML Help Workshop to the ^
|
|
default path [C:\Program Files (x86)\HTML Help Workshop] or ^
|
|
set the variable HHCBUILD to the path to hhc.exe.
|
|
goto end
|
|
)
|
|
|
|
if "%1" == "qthelp" (
|
|
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
|
|
if errorlevel 1 exit /b 1
|
|
echo.
|
|
echo.Build finished; now you can run "qcollectiongenerator" with the ^
|
|
.qhcp project file in %BUILDDIR%/qthelp, like this:
|
|
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\RenderDoc.qhcp
|
|
echo.To view the help file:
|
|
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\RenderDoc.ghc
|
|
goto end
|
|
)
|
|
|
|
if "%1" == "devhelp" (
|
|
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
|
|
if errorlevel 1 exit /b 1
|
|
echo.
|
|
echo.Build finished.
|
|
goto end
|
|
)
|
|
|
|
if "%1" == "epub" (
|
|
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
|
|
if errorlevel 1 exit /b 1
|
|
echo.
|
|
echo.Build finished. The epub file is in %BUILDDIR%/epub.
|
|
goto end
|
|
)
|
|
|
|
if "%1" == "epub3" (
|
|
%SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3
|
|
if errorlevel 1 exit /b 1
|
|
echo.
|
|
echo.Build finished. The epub3 file is in %BUILDDIR%/epub3.
|
|
goto end
|
|
)
|
|
|
|
if "%1" == "latex" (
|
|
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
|
if errorlevel 1 exit /b 1
|
|
echo.
|
|
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
|
|
goto end
|
|
)
|
|
|
|
if "%1" == "latexpdf" (
|
|
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
|
cd %BUILDDIR%/latex
|
|
make all-pdf
|
|
cd %~dp0
|
|
echo.
|
|
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
|
|
goto end
|
|
)
|
|
|
|
if "%1" == "latexpdfja" (
|
|
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
|
cd %BUILDDIR%/latex
|
|
make all-pdf-ja
|
|
cd %~dp0
|
|
echo.
|
|
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
|
|
goto end
|
|
)
|
|
|
|
if "%1" == "text" (
|
|
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
|
|
if errorlevel 1 exit /b 1
|
|
echo.
|
|
echo.Build finished. The text files are in %BUILDDIR%/text.
|
|
goto end
|
|
)
|
|
|
|
if "%1" == "man" (
|
|
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
|
|
if errorlevel 1 exit /b 1
|
|
echo.
|
|
echo.Build finished. The manual pages are in %BUILDDIR%/man.
|
|
goto end
|
|
)
|
|
|
|
if "%1" == "texinfo" (
|
|
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
|
|
if errorlevel 1 exit /b 1
|
|
echo.
|
|
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
|
|
goto end
|
|
)
|
|
|
|
if "%1" == "gettext" (
|
|
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
|
|
if errorlevel 1 exit /b 1
|
|
echo.
|
|
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
|
|
goto end
|
|
)
|
|
|
|
if "%1" == "changes" (
|
|
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
|
|
if errorlevel 1 exit /b 1
|
|
echo.
|
|
echo.The overview file is in %BUILDDIR%/changes.
|
|
goto end
|
|
)
|
|
|
|
if "%1" == "linkcheck" (
|
|
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
|
|
if errorlevel 1 exit /b 1
|
|
echo.
|
|
echo.Link check complete; look for any errors in the above output ^
|
|
or in %BUILDDIR%/linkcheck/output.txt.
|
|
goto end
|
|
)
|
|
|
|
if "%1" == "doctest" (
|
|
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
|
|
if errorlevel 1 exit /b 1
|
|
echo.
|
|
echo.Testing of doctests in the sources finished, look at the ^
|
|
results in %BUILDDIR%/doctest/output.txt.
|
|
goto end
|
|
)
|
|
|
|
if "%1" == "coverage" (
|
|
%SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage
|
|
if errorlevel 1 exit /b 1
|
|
echo.
|
|
echo.Testing of coverage in the sources finished, look at the ^
|
|
results in %BUILDDIR%/coverage/python.txt.
|
|
goto end
|
|
)
|
|
|
|
if "%1" == "xml" (
|
|
%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
|
|
if errorlevel 1 exit /b 1
|
|
echo.
|
|
echo.Build finished. The XML files are in %BUILDDIR%/xml.
|
|
goto end
|
|
)
|
|
|
|
if "%1" == "pseudoxml" (
|
|
%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
|
|
if errorlevel 1 exit /b 1
|
|
echo.
|
|
echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
|
|
goto end
|
|
)
|
|
|
|
if "%1" == "dummy" (
|
|
%SPHINXBUILD% -b dummy %ALLSPHINXOPTS% %BUILDDIR%/dummy
|
|
if errorlevel 1 exit /b 1
|
|
echo.
|
|
echo.Build finished. Dummy builder generates no files.
|
|
goto end
|
|
)
|
|
|
|
:end
|