Go to most recent revision |
Blame |
Last modification |
View Log
| RSS feed
REM Command file for Sphinx documentation
set SPHINXBUILD=sphinx-build
set ALLSPHINXOPTS=-d
%BUILDDIR%/doctrees
%SPHINXOPTS% source
set ALLSPHINXOPTS=-D latex_paper_size=
%PAPER% %ALLSPHINXOPTS%
)
: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. 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. latex to make LaTeX files, you can
set PAPER=a4 or PAPER=letter
echo. changes to make an overview over all changed/added/deprecated items
echo. linkcheck to check all external links
for integrity
echo. doctest to run all doctests embedded
in the documentation
if enabled
)
)
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
echo.Build finished. The HTML pages are
in %BUILDDIR%/html.
)
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
echo.Build finished. The HTML pages are
in %BUILDDIR%/dirhtml.
)
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
echo.Build finished; now you can process the pickle files.
)
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
echo.Build finished; now you can process the JSON files.
)
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
echo.Build finished; now you can run HTML Help Workshop with the ^
.hhp project file
in %BUILDDIR%/htmlhelp.
)
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file
in %BUILDDIR%/qthelp, like this:
echo.
^> qcollectiongenerator
%BUILDDIR%\qthelp\Gallium.qhcp
echo.To view the help file:
echo.
^> assistant -collectionFile
%BUILDDIR%\qthelp\Gallium.ghc
)
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
echo.Build finished; the LaTeX files are
in %BUILDDIR%/latex.
)
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
echo.The overview file is
in %BUILDDIR%/changes.
)
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
echo.Link check complete; look
for any errors
in the above output ^
or
in %BUILDDIR%/linkcheck/output.txt.
)
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
echo.Testing of doctests
in the sources finished, look at the ^
results
in %BUILDDIR%/doctest/output.txt.
)
:end