Ignore:
Timestamp:
Dec 29, 2015, 3:02:11 PM (4 years ago)
Author:
cito
Message:

Update Sphinx conf and make files

Update the conf and make files for creating the documentation
so that newer Sphinx features are supported.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/4.x/docs/make.bat

    r516 r669  
    3434        echo.  gettext    to make PO message catalogs
    3535        echo.  changes    to make an overview over all changed/added/deprecated items
     36        echo.  xml        to make Docutils-native XML files
     37        echo.  pseudoxml  to make pseudoxml-XML files for display purposes
    3638        echo.  linkcheck  to check all external links for integrity
    3739        echo.  doctest    to run all doctests embedded in the documentation if enabled
     40        echo.  coverage   to run coverage check of the documentation if enabled
    3841        goto end
    3942)
     
    4447        goto end
    4548)
     49
     50
     51REM Check if sphinx-build is available and fallback to Python version if any
     52%SPHINXBUILD% 1>NUL 2>NUL
     53if errorlevel 9009 goto sphinx_python
     54goto sphinx_ok
     55
     56:sphinx_python
     57
     58set SPHINXBUILD=python -m sphinx.__init__
     59%SPHINXBUILD% 2> nul
     60if errorlevel 9009 (
     61        echo.
     62        echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
     63        echo.installed, then set the SPHINXBUILD environment variable to point
     64        echo.to the full path of the 'sphinx-build' executable. Alternatively you
     65        echo.may add the Sphinx directory to PATH.
     66        echo.
     67        echo.If you don't have Sphinx installed, grab it from
     68        echo.http://sphinx-doc.org/
     69        exit /b 1
     70)
     71
     72:sphinx_ok
     73
    4674
    4775if "%1" == "html" (
     
    130158)
    131159
     160if "%1" == "latexpdf" (
     161        %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
     162        cd %BUILDDIR%/latex
     163        make all-pdf
     164        cd %~dp0
     165        echo.
     166        echo.Build finished; the PDF files are in %BUILDDIR%/latex.
     167        goto end
     168)
     169
     170if "%1" == "latexpdfja" (
     171        %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
     172        cd %BUILDDIR%/latex
     173        make all-pdf-ja
     174        cd %~dp0
     175        echo.
     176        echo.Build finished; the PDF files are in %BUILDDIR%/latex.
     177        goto end
     178)
     179
    132180if "%1" == "text" (
    133181        %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
     
    188236)
    189237
     238if "%1" == "coverage" (
     239        %SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage
     240        if errorlevel 1 exit /b 1
     241        echo.
     242        echo.Testing of coverage in the sources finished, look at the ^
     243results in %BUILDDIR%/coverage/python.txt.
     244        goto end
     245)
     246
     247if "%1" == "xml" (
     248        %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
     249        if errorlevel 1 exit /b 1
     250        echo.
     251        echo.Build finished. The XML files are in %BUILDDIR%/xml.
     252        goto end
     253)
     254
     255if "%1" == "pseudoxml" (
     256        %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
     257        if errorlevel 1 exit /b 1
     258        echo.
     259        echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
     260        goto end
     261)
     262
    190263:end
Note: See TracChangeset for help on using the changeset viewer.