docs/make.bat

   1 @ECHO OFF\r
   2 \r
   3 REM Command file for Sphinx documentation\r
   4 \r
   5 if "%SPHINXBUILD%" == "" (\r
   6         set SPHINXBUILD=sphinx-build\r
   7 )\r
   8 set BUILDDIR=_build\r
   9 set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .\r
  10 set I18NSPHINXOPTS=%SPHINXOPTS% .\r
  11 if NOT "%PAPER%" == "" (\r
  12         set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%\r
  13         set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%\r
  14 )\r
  15 \r
  16 if "%1" == "" goto help\r
  17 \r
  18 if "%1" == "help" (\r
  19         :help\r
  20         echo.Please use `make ^<target^>` where ^<target^> is one of\r
  21         echo.  html       to make standalone HTML files\r
  22         echo.  dirhtml    to make HTML files named index.html in directories\r
  23         echo.  singlehtml to make a single large HTML file\r
  24         echo.  pickle     to make pickle files\r
  25         echo.  json       to make JSON files\r
  26         echo.  htmlhelp   to make HTML files and a HTML help project\r
  27         echo.  qthelp     to make HTML files and a qthelp project\r
  28         echo.  devhelp    to make HTML files and a Devhelp project\r
  29         echo.  epub       to make an epub\r
  30         echo.  epub3      to make an epub3\r
  31         echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter\r
  32         echo.  text       to make text files\r
  33         echo.  man        to make manual pages\r
  34         echo.  texinfo    to make Texinfo files\r
  35         echo.  gettext    to make PO message catalogs\r
  36         echo.  changes    to make an overview over all changed/added/deprecated items\r
  37         echo.  xml        to make Docutils-native XML files\r
  38         echo.  pseudoxml  to make pseudoxml-XML files for display purposes\r
  39         echo.  linkcheck  to check all external links for integrity\r
  40         echo.  doctest    to run all doctests embedded in the documentation if enabled\r
  41         echo.  coverage   to run coverage check of the documentation if enabled\r
  42         goto end\r
  43 )\r
  44 \r
  45 if "%1" == "clean" (\r
  46         for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i\r
  47         del /q /s %BUILDDIR%\*\r
  48         goto end\r
  49 )\r
  50 \r
  51 \r
  52 REM Check if sphinx-build is available and fallback to Python version if any\r
  53 %SPHINXBUILD% 1>NUL 2>NUL\r
  54 if errorlevel 9009 goto sphinx_python\r
  55 goto sphinx_ok\r
  56 \r
  57 :sphinx_python\r
  58 \r
  59 set SPHINXBUILD=python -m sphinx.__init__\r
  60 %SPHINXBUILD% 2> nul\r
  61 if errorlevel 9009 (\r
  62         echo.\r
  63         echo.The 'sphinx-build' command was not found. Make sure you have Sphinx\r
  64         echo.installed, then set the SPHINXBUILD environment variable to point\r
  65         echo.to the full path of the 'sphinx-build' executable. Alternatively you\r
  66         echo.may add the Sphinx directory to PATH.\r
  67         echo.\r
  68         echo.If you don't have Sphinx installed, grab it from\r
  69         echo.http://sphinx-doc.org/\r
  70         exit /b 1\r
  71 )\r
  72 \r
  73 :sphinx_ok\r
  74 \r
  75 \r
  76 if "%1" == "html" (\r
  77         %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html\r
  78         if errorlevel 1 exit /b 1\r
  79         echo.\r
  80         echo.Build finished. The HTML pages are in %BUILDDIR%/html.\r
  81         goto end\r
  82 )\r
  83 \r
  84 if "%1" == "dirhtml" (\r
  85         %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml\r
  86         if errorlevel 1 exit /b 1\r
  87         echo.\r
  88         echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.\r
  89         goto end\r
  90 )\r
  91 \r
  92 if "%1" == "singlehtml" (\r
  93         %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml\r
  94         if errorlevel 1 exit /b 1\r
  95         echo.\r
  96         echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.\r
  97         goto end\r
  98 )\r
  99 \r
 100 if "%1" == "pickle" (\r
 101         %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle\r
 102         if errorlevel 1 exit /b 1\r
 103         echo.\r
 104         echo.Build finished; now you can process the pickle files.\r
 105         goto end\r
 106 )\r
 107 \r
 108 if "%1" == "json" (\r
 109         %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json\r
 110         if errorlevel 1 exit /b 1\r
 111         echo.\r
 112         echo.Build finished; now you can process the JSON files.\r
 113         goto end\r
 114 )\r
 115 \r
 116 if "%1" == "htmlhelp" (\r
 117         %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp\r
 118         if errorlevel 1 exit /b 1\r
 119         echo.\r
 120         echo.Build finished; now you can run HTML Help Workshop with the ^\r
 121 .hhp project file in %BUILDDIR%/htmlhelp.\r
 122         goto end\r
 123 )\r
 124 \r
 125 if "%1" == "qthelp" (\r
 126         %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp\r
 127         if errorlevel 1 exit /b 1\r
 128         echo.\r
 129         echo.Build finished; now you can run "qcollectiongenerator" with the ^\r
 130 .qhcp project file in %BUILDDIR%/qthelp, like this:\r
 131         echo.^> qcollectiongenerator %BUILDDIR%\qthelp\OpenDaylightDocumentation.qhcp\r
 132         echo.To view the help file:\r
 133         echo.^> assistant -collectionFile %BUILDDIR%\qthelp\OpenDaylightDocumentation.ghc\r
 134         goto end\r
 135 )\r
 136 \r
 137 if "%1" == "devhelp" (\r
 138         %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp\r
 139         if errorlevel 1 exit /b 1\r
 140         echo.\r
 141         echo.Build finished.\r
 142         goto end\r
 143 )\r
 144 \r
 145 if "%1" == "epub" (\r
 146         %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub\r
 147         if errorlevel 1 exit /b 1\r
 148         echo.\r
 149         echo.Build finished. The epub file is in %BUILDDIR%/epub.\r
 150         goto end\r
 151 )\r
 152 \r
 153 if "%1" == "epub3" (\r
 154         %SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3\r
 155         if errorlevel 1 exit /b 1\r
 156         echo.\r
 157         echo.Build finished. The epub3 file is in %BUILDDIR%/epub3.\r
 158         goto end\r
 159 )\r
 160 \r
 161 if "%1" == "latex" (\r
 162         %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex\r
 163         if errorlevel 1 exit /b 1\r
 164         echo.\r
 165         echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.\r
 166         goto end\r
 167 )\r
 168 \r
 169 if "%1" == "latexpdf" (\r
 170         %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex\r
 171         cd %BUILDDIR%/latex\r
 172         make all-pdf\r
 173         cd %~dp0\r
 174         echo.\r
 175         echo.Build finished; the PDF files are in %BUILDDIR%/latex.\r
 176         goto end\r
 177 )\r
 178 \r
 179 if "%1" == "latexpdfja" (\r
 180         %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex\r
 181         cd %BUILDDIR%/latex\r
 182         make all-pdf-ja\r
 183         cd %~dp0\r
 184         echo.\r
 185         echo.Build finished; the PDF files are in %BUILDDIR%/latex.\r
 186         goto end\r
 187 )\r
 188 \r
 189 if "%1" == "text" (\r
 190         %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text\r
 191         if errorlevel 1 exit /b 1\r
 192         echo.\r
 193         echo.Build finished. The text files are in %BUILDDIR%/text.\r
 194         goto end\r
 195 )\r
 196 \r
 197 if "%1" == "man" (\r
 198         %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man\r
 199         if errorlevel 1 exit /b 1\r
 200         echo.\r
 201         echo.Build finished. The manual pages are in %BUILDDIR%/man.\r
 202         goto end\r
 203 )\r
 204 \r
 205 if "%1" == "texinfo" (\r
 206         %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo\r
 207         if errorlevel 1 exit /b 1\r
 208         echo.\r
 209         echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.\r
 210         goto end\r
 211 )\r
 212 \r
 213 if "%1" == "gettext" (\r
 214         %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale\r
 215         if errorlevel 1 exit /b 1\r
 216         echo.\r
 217         echo.Build finished. The message catalogs are in %BUILDDIR%/locale.\r
 218         goto end\r
 219 )\r
 220 \r
 221 if "%1" == "changes" (\r
 222         %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes\r
 223         if errorlevel 1 exit /b 1\r
 224         echo.\r
 225         echo.The overview file is in %BUILDDIR%/changes.\r
 226         goto end\r
 227 )\r
 228 \r
 229 if "%1" == "linkcheck" (\r
 230         %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck\r
 231         if errorlevel 1 exit /b 1\r
 232         echo.\r
 233         echo.Link check complete; look for any errors in the above output ^\r
 234 or in %BUILDDIR%/linkcheck/output.txt.\r
 235         goto end\r
 236 )\r
 237 \r
 238 if "%1" == "doctest" (\r
 239         %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest\r
 240         if errorlevel 1 exit /b 1\r
 241         echo.\r
 242         echo.Testing of doctests in the sources finished, look at the ^\r
 243 results in %BUILDDIR%/doctest/output.txt.\r
 244         goto end\r
 245 )\r
 246 \r
 247 if "%1" == "coverage" (\r
 248         %SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage\r
 249         if errorlevel 1 exit /b 1\r
 250         echo.\r
 251         echo.Testing of coverage in the sources finished, look at the ^\r
 252 results in %BUILDDIR%/coverage/python.txt.\r
 253         goto end\r
 254 )\r
 255 \r
 256 if "%1" == "xml" (\r
 257         %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml\r
 258         if errorlevel 1 exit /b 1\r
 259         echo.\r
 260         echo.Build finished. The XML files are in %BUILDDIR%/xml.\r
 261         goto end\r
 262 )\r
 263 \r
 264 if "%1" == "pseudoxml" (\r
 265         %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml\r
 266         if errorlevel 1 exit /b 1\r
 267         echo.\r
 268         echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.\r
 269         goto end\r
 270 )\r
 271 \r
 272 :end\r