diff options
| author | Daniël van Noord <13665637+DanielNoord@users.noreply.github.com> | 2022-04-13 12:20:14 +0200 |
|---|---|---|
| committer | Daniël van Noord <13665637+DanielNoord@users.noreply.github.com> | 2022-04-13 12:35:14 +0200 |
| commit | 897ea1d8fa389d96593feef4bdd923f4edbaff13 (patch) | |
| tree | 1227203736717bc4ca48c6f7b72203ddb4ea7ec5 /doc/make.bat | |
| parent | ac036e45ff2d9fbcaf11b42d928364c993a5c384 (diff) | |
| download | pylint-git-897ea1d8fa389d96593feef4bdd923f4edbaff13.tar.gz | |
Update Sphinx makefiles with options used on readthedocs
Diffstat (limited to 'doc/make.bat')
| -rw-r--r-- | doc/make.bat | 28 |
1 files changed, 6 insertions, 22 deletions
diff --git a/doc/make.bat b/doc/make.bat index 7c754602b..64127d62a 100644 --- a/doc/make.bat +++ b/doc/make.bat @@ -6,11 +6,9 @@ if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) set BUILDDIR=_build -set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . -set I18NSPHINXOPTS=%SPHINXOPTS% . +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees -T -E -W --keep-going . if NOT "%PAPER%" == "" ( set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% - set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% ) if "%1" == "" goto help @@ -34,7 +32,6 @@ if "%1" == "help" ( echo. gettext to make PO message catalogs 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 goto end ) @@ -46,17 +43,13 @@ if "%1" == "clean" ( if "%1" == "html" ( - rm -f features.rst - echo Pylint features > reference_guide/features.rst - echo =============== >> reference_guide/features.rst - echo >> reference_guide/features.rst - echo .. generated by pylint --full-documentation >> reference_guide/features.rst - echo >> reference_guide/features.rst - python -m pylint --full-documentation >> reference_guide/features.rst %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html if errorlevel 1 exit /b 1 + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/html. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. goto end ) @@ -162,7 +155,7 @@ if "%1" == "texinfo" ( ) if "%1" == "gettext" ( - %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale + %SPHINXBUILD% -b gettext %ALLSPHINXOPTS% %BUILDDIR%/locale if errorlevel 1 exit /b 1 echo. echo.Build finished. The message catalogs are in %BUILDDIR%/locale. @@ -186,13 +179,4 @@ 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 -) - :end |