Skip to content
GitLab
Select Git revision
  • dev default
  • 1.5
  • 287-the-dyngroup-plugin-should-be-dyngroups-in-the-documentation
  • master
  • 1.4
  • 1.3
  • fusiondirectory-1.5
  • fusiondirectory-1.3.1
  • fusiondirectory-1.4
Find file BlameHistoryPermalink
make.bat 7.60 KiB
1 
@ECHO OFF
2
3 
REM Command file for Sphinx documentation
4
5 
if "%SPHINXBUILD%" == "" (
6 
	set SPHINXBUILD=sphinx-build
7 
)
8 
set BUILDDIR=build
9 
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
10 
set I18NSPHINXOPTS=%SPHINXOPTS% source
11 
if NOT "%PAPER%" == "" (
12 
	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
13 
	set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
14 
)
15
16 
if "%1" == "" goto help
17
18 
if "%1" == "help" (
19 
	:help
20 
	echo.Please use `make ^<target^>` where ^<target^> is one of
21 
	echo.  html       to make standalone HTML files
22 
	echo.  dirhtml    to make HTML files named index.html in directories
23 
	echo.  singlehtml to make a single large HTML file
24 
	echo.  pickle     to make pickle files
25 
	echo.  json       to make JSON files
26 
	echo.  htmlhelp   to make HTML files and a HTML help project
27 
	echo.  qthelp     to make HTML files and a qthelp project
28 
	echo.  devhelp    to make HTML files and a Devhelp project
29 
	echo.  epub       to make an epub
30 
	echo.  epub3      to make an epub3
31 
	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
32 
	echo.  text       to make text files
33 
	echo.  man        to make manual pages
34 
	echo.  texinfo    to make Texinfo files
35 
	echo.  gettext    to make PO message catalogs
36 
	echo.  changes    to make an overview over all changed/added/deprecated items
37 
	echo.  xml        to make Docutils-native XML files
38 
	echo.  pseudoxml  to make pseudoxml-XML files for display purposes
39 
	echo.  linkcheck  to check all external links for integrity
40 
	echo.  doctest    to run all doctests embedded in the documentation if enabled
41 
	echo.  coverage   to run coverage check of the documentation if enabled
42 
	echo.  dummy      to check syntax errors of document sources
43 
	goto end
44 
)
45
46 
if "%1" == "clean" (
47 
	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
48 
	del /q /s %BUILDDIR%\*
49 
	goto end
50 
)
51
52
53 
REM Check if sphinx-build is available and fallback to Python version if any
54 
%SPHINXBUILD% 1>NUL 2>NUL
55 
if errorlevel 9009 goto sphinx_python
56 
goto sphinx_ok
57
58 
:sphinx_python
59
60 
set SPHINXBUILD=python -m sphinx.__init__
61 
%SPHINXBUILD% 2> nul
62 
if errorlevel 9009 (
63 
	echo.
64 
	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
65 
	echo.installed, then set the SPHINXBUILD environment variable to point
66 
	echo.to the full path of the 'sphinx-build' executable. Alternatively you
67 
	echo.may add the Sphinx directory to PATH.
68 
	echo.
69 
	echo.If you don't have Sphinx installed, grab it from
70 
	echo.http://sphinx-doc.org/
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
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 %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run HTML Help Workshop with the ^ .hhp project file in %BUILDDIR%/htmlhelp. 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\FusionDirectoryUserManual.qhcp echo.To view the help file: echo.^> assistant -collectionFile %BUILDDIR%\qthelp\FusionDirectoryUserManual.ghc goto end ) if "%1" == "devhelp" ( %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp if errorlevel 1 exit /b 1
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
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.
211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
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 )
281282
:end