IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Closes #4614: sphinx-build: Add :option:--keep-going option to show all warnings

Browse Source
This commit is contained in:
Takeshi KOMIYA 2018-07-19 23:48:19 +09:00
parent 5c6bb4293d
commit e3483e9b04
4 changed files with 21 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGES
View File

@ -162,6 +162,7 @@ Features added
if :confval:`latex_engine` is ``'xelatex'`` or ``'lualatex'``. if :confval:`latex_engine` is ``'xelatex'`` or ``'lualatex'``.
* #4976: ``SphinxLoggerAdapter.info()`` now supports ``location`` parameter * #4976: ``SphinxLoggerAdapter.info()`` now supports ``location`` parameter
* #5122: setuptools: support nitpicky option * #5122: setuptools: support nitpicky option
* #4614: sphinx-build: Add ``--keep-going`` option to show all warnings
Bugs fixed Bugs fixed
---------- ----------

7
doc/man/sphinx-build.rst
View File

@ -229,6 +229,13 @@ Options
Turn warnings into errors. This means that the build stops at the first Turn warnings into errors. This means that the build stops at the first
warning and ``sphinx-build`` exits with exit status 1. warning and ``sphinx-build`` exits with exit status 1.
.. option:: --keep-going
With -W option, keep going processing when getting warnings to the end
of build, and ``sphinx-build`` exits with exit status 1.
.. versionadded:: 1.8
.. option:: -T .. option:: -T
Display the full traceback when an unhandled exception occurs. Otherwise, Display the full traceback when an unhandled exception occurs. Otherwise,

13
sphinx/application.py
View File

@ -128,8 +128,8 @@ class Sphinx(object):
def __init__(self, srcdir, confdir, outdir, doctreedir, buildername, def __init__(self, srcdir, confdir, outdir, doctreedir, buildername,
confoverrides=None, status=sys.stdout, warning=sys.stderr, confoverrides=None, status=sys.stdout, warning=sys.stderr,
freshenv=False, warningiserror=False, tags=None, verbosity=0, freshenv=False, warningiserror=False, tags=None, verbosity=0,
parallel=0): parallel=0, keep_going=False):
# type: (unicode, unicode, unicode, unicode, unicode, Dict, IO, IO, bool, bool, List[unicode], int, int) -> None # NOQA # type: (unicode, unicode, unicode, unicode, unicode, Dict, IO, IO, bool, bool, List[unicode], int, int, bool) -> None # NOQA
self.phase = BuildPhase.INITIALIZATION self.phase = BuildPhase.INITIALIZATION
self.verbosity = verbosity self.verbosity = verbosity
self.extensions = {} # type: Dict[unicode, Extension] self.extensions = {} # type: Dict[unicode, Extension]
@ -172,7 +172,11 @@ class Sphinx(object):
else: else:
self._warning = warning self._warning = warning
self._warncount = 0 self._warncount = 0
self.warningiserror = warningiserror self.keep_going = warningiserror and keep_going
if self.keep_going:
self.warningiserror = False
else:
self.warningiserror = warningiserror
logging.setup(self, self._status, self._warning) logging.setup(self, self._status, self._warning)
self.events = EventManager() self.events = EventManager()
@ -334,6 +338,9 @@ class Sphinx(object):
self.builder.compile_update_catalogs() self.builder.compile_update_catalogs()
self.builder.build_update() self.builder.build_update()
if self._warncount and self.keep_going:
self.statuscode = 1
status = (self.statuscode == 0 and status = (self.statuscode == 0 and
__('succeeded') or __('finished with problems')) __('succeeded') or __('finished with problems'))
if self._warncount: if self._warncount:

4
sphinx/cmd/build.py
View File

@ -189,6 +189,8 @@ files can be built by specifying individual filenames.
help=__('write warnings (and errors) to given file')) help=__('write warnings (and errors) to given file'))
group.add_argument('-W', action='store_true', dest='warningiserror', group.add_argument('-W', action='store_true', dest='warningiserror',
help=__('turn warnings into errors')) help=__('turn warnings into errors'))
group.add_argument('--keep-going', action='store_true', dest='keep_going',
help=__("With -W, Keep going when getting warnings"))
group.add_argument('-T', action='store_true', dest='traceback', group.add_argument('-T', action='store_true', dest='traceback',
help=__('show full traceback on exception')) help=__('show full traceback on exception'))
group.add_argument('-P', action='store_true', dest='pdb', group.add_argument('-P', action='store_true', dest='pdb',
@ -298,7 +300,7 @@ def build_main(argv=sys.argv[1:]): # type: ignore
app = Sphinx(args.sourcedir, args.confdir, args.outputdir, app = Sphinx(args.sourcedir, args.confdir, args.outputdir,
args.doctreedir, args.builder, confoverrides, status, args.doctreedir, args.builder, confoverrides, status,
warning, args.freshenv, args.warningiserror, warning, args.freshenv, args.warningiserror,
args.tags, args.verbosity, args.jobs) args.tags, args.verbosity, args.jobs, args.keep_going)
app.build(args.force_all, filenames) app.build(args.force_all, filenames)
return app.statuscode return app.statuscode
except (Exception, KeyboardInterrupt) as exc: except (Exception, KeyboardInterrupt) as exc: