5
:: Command file for Sphinx documentation
7
if "%SPHINXBUILD%" == "" (
8
set SPHINXBUILD=LANG=C sphinx-build
12
if defined SPHINXOPTS goto skipopts
13
set SPHINXOPTS=-W --keep-going -d build/doctrees %SPHINXOPTS% source
18
if "%1" == "" goto help
19
if "%1" == "clean" goto clean
20
if "%1" == "docenv" goto docenv
21
if "%1" == "html" goto html
22
if "%1" == "linkcheck" goto linkcheck
23
if "%1" == "show" goto show
27
echo Please use "make.bat <target>" where ^<target^> is one of
29
echo clean to remove generated doc files and start fresh
30
echo docenv make a virtual environment in which to build docs
31
echo html to make standalone HTML files
32
echo linkcheck to check all external links for integrity
33
echo show to show the html output in a browser
37
if exist "%SOURCEDIR%\build\" (
38
rmdir /s /q "%SOURCEDIR%\build"
40
:: find . -name generated -type d -prune -exec rm -rf "{}" ";"
46
Rem python -mvenv docenv
48
Rem . docenv/bin/activate; \
49
Rem pip install -q --upgrade pip; \
50
Rem pip install -q -r ../requirements/test_requirements.txt; \
51
Rem pip install -q -r ../requirements/doc_requirements.txt; \
52
Rem pip install -q ..; \
57
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
64
%SPHINXBUILD% -b linkcheck %SOURCEDIR% build\linkcheck
66
echo Link check complete; look for any errors in the above output
67
echo or in build\linkcheck\output.txt.
71
python -m webbrowser -t "%~dp0\build\html\index.html"