docs/build/make.bat
changeset 79 e12e18e99a68
parent 78 54aeb42c0d80
child 80 137705383aaf
equal deleted inserted replaced
78:54aeb42c0d80 79:e12e18e99a68
     1 @ECHO OFF
       
     2 
       
     3 REM Command file for Sphinx documentation
       
     4 
       
     5 if "%SPHINXBUILD%" == "" (
       
     6 	set SPHINXBUILD=sphinx-build
       
     7 )
       
     8 set BUILDDIR=/home/borax/Dropbox/src/PyAMS/pyams_utils/docs/build
       
     9 set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% /home/borax/Dropbox/src/PyAMS/pyams_utils/docs/source
       
    10 set I18NSPHINXOPTS=%SPHINXOPTS% /home/borax/Dropbox/src/PyAMS/pyams_utils/docs/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.  warnings-html to make standalone HTML files (turn warnings into errors)
       
    23 	echo.  dirhtml    to make HTML files named index.html in directories
       
    24 	echo.  singlehtml to make a single large HTML file
       
    25 	echo.  pickle     to make pickle files
       
    26 	echo.  json       to make JSON files
       
    27 	echo.  htmlhelp   to make HTML files and a HTML help project
       
    28 	echo.  qthelp     to make HTML files and a qthelp project
       
    29 	echo.  devhelp    to make HTML files and a Devhelp project
       
    30 	echo.  epub       to make an epub
       
    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.  linkcheck  to check all external links for integrity
       
    38 	echo.  doctest    to run all doctests embedded in the documentation if enabled
       
    39 	goto end
       
    40 )
       
    41 
       
    42 if "%1" == "clean" (
       
    43 	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
       
    44 	del /q /s %BUILDDIR%\*
       
    45 	goto end
       
    46 )
       
    47 
       
    48 if "%1" == "html" (
       
    49 	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
       
    50 	if errorlevel 1 exit /b 1
       
    51 	echo.
       
    52 	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
       
    53 	goto end
       
    54 )
       
    55 
       
    56 if "%1" == "warnings-html" (
       
    57 	%SPHINXBUILD% -W -b html %ALLSPHINXOPTS% %BUILDDIR%/html
       
    58 	if errorlevel 1 exit /b 1
       
    59 	echo.
       
    60 	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
       
    61 	goto end
       
    62 )
       
    63 
       
    64 if "%1" == "dirhtml" (
       
    65 	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
       
    66 	if errorlevel 1 exit /b 1
       
    67 	echo.
       
    68 	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
       
    69 	goto end
       
    70 )
       
    71 
       
    72 if "%1" == "singlehtml" (
       
    73 	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
       
    74 	if errorlevel 1 exit /b 1
       
    75 	echo.
       
    76 	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
       
    77 	goto end
       
    78 )
       
    79 
       
    80 if "%1" == "pickle" (
       
    81 	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
       
    82 	if errorlevel 1 exit /b 1
       
    83 	echo.
       
    84 	echo.Build finished; now you can process the pickle files.
       
    85 	goto end
       
    86 )
       
    87 
       
    88 if "%1" == "json" (
       
    89 	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
       
    90 	if errorlevel 1 exit /b 1
       
    91 	echo.
       
    92 	echo.Build finished; now you can process the JSON files.
       
    93 	goto end
       
    94 )
       
    95 
       
    96 if "%1" == "htmlhelp" (
       
    97 	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
       
    98 	if errorlevel 1 exit /b 1
       
    99 	echo.
       
   100 	echo.Build finished; now you can run HTML Help Workshop with the ^
       
   101 .hhp project file in %BUILDDIR%/htmlhelp.
       
   102 	goto end
       
   103 )
       
   104 
       
   105 if "%1" == "qthelp" (
       
   106 	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
       
   107 	if errorlevel 1 exit /b 1
       
   108 	echo.
       
   109 	echo.Build finished; now you can run "qcollectiongenerator" with the ^
       
   110 .qhcp project file in %BUILDDIR%/qthelp, like this:
       
   111 	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\sphinx.qhcp
       
   112 	echo.To view the help file:
       
   113 	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\sphinx.ghc
       
   114 	goto end
       
   115 )
       
   116 
       
   117 if "%1" == "devhelp" (
       
   118 	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
       
   119 	if errorlevel 1 exit /b 1
       
   120 	echo.
       
   121 	echo.Build finished.
       
   122 	goto end
       
   123 )
       
   124 
       
   125 if "%1" == "epub" (
       
   126 	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
       
   127 	if errorlevel 1 exit /b 1
       
   128 	echo.
       
   129 	echo.Build finished. The epub file is in %BUILDDIR%/epub.
       
   130 	goto end
       
   131 )
       
   132 
       
   133 if "%1" == "latex" (
       
   134 	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
       
   135 	if errorlevel 1 exit /b 1
       
   136 	echo.
       
   137 	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
       
   138 	goto end
       
   139 )
       
   140 
       
   141 if "%1" == "text" (
       
   142 	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
       
   143 	if errorlevel 1 exit /b 1
       
   144 	echo.
       
   145 	echo.Build finished. The text files are in %BUILDDIR%/text.
       
   146 	goto end
       
   147 )
       
   148 
       
   149 if "%1" == "man" (
       
   150 	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
       
   151 	if errorlevel 1 exit /b 1
       
   152 	echo.
       
   153 	echo.Build finished. The manual pages are in %BUILDDIR%/man.
       
   154 	goto end
       
   155 )
       
   156 
       
   157 if "%1" == "texinfo" (
       
   158 	%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
       
   159 	if errorlevel 1 exit /b 1
       
   160 	echo.
       
   161 	echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
       
   162 	goto end
       
   163 )
       
   164 
       
   165 if "%1" == "gettext" (
       
   166 	%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
       
   167 	if errorlevel 1 exit /b 1
       
   168 	echo.
       
   169 	echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
       
   170 	goto end
       
   171 )
       
   172 
       
   173 if "%1" == "changes" (
       
   174 	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
       
   175 	if errorlevel 1 exit /b 1
       
   176 	echo.
       
   177 	echo.The overview file is in %BUILDDIR%/changes.
       
   178 	goto end
       
   179 )
       
   180 
       
   181 if "%1" == "linkcheck" (
       
   182 	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
       
   183 	if errorlevel 1 exit /b 1
       
   184 	echo.
       
   185 	echo.Link check complete; look for any errors in the above output ^
       
   186 or in %BUILDDIR%/linkcheck/output.txt.
       
   187 	goto end
       
   188 )
       
   189 
       
   190 if "%1" == "doctest" (
       
   191 	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
       
   192 	if errorlevel 1 exit /b 1
       
   193 	echo.
       
   194 	echo.Testing of doctests in the sources finished, look at the ^
       
   195 results in %BUILDDIR%/doctest/output.txt.
       
   196 	goto end
       
   197 )
       
   198 
       
   199 :end