diff options
| author | Daniel Vetter <daniel.vetter@ffwll.ch> | 2016-07-19 13:42:54 +0200 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2016-07-19 16:22:20 -0600 |
| commit | 47d6d752b9e20dbe8a2acd22e887be81a6f39de9 (patch) | |
| tree | 33e4ef3143f359c5b2d5ac74c74465ced6e70593 /Documentation | |
| parent | e6507a00fd08986ce003012a10af78cc7e47eee8 (diff) | |
doc/sphinx: Enable keep_warnings
Unfortunately warnings generated after parsing in sphinx can end up
with entirely bogus files and line numbers as sources. Strangely for
outright errors this is not a problem. Trying to convert warnings to
errors also doesn't fix it.
The only way to get useful output out of sphinx to be able to root
cause the error seems to be enabling keep_warnings, which inserts
a System Message into the actual output. Not pretty at all, but I
don't really want to fix up core rst/sphinx code, and this gets the job
done meanwhile.
Cc: Markus Heiser <markus.heiser@darmarit.de>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/conf.py | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/conf.py b/Documentation/conf.py index 792b6338ef19..49c242cf18c5 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -125,7 +125,7 @@ pygments_style = 'sphinx' #modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False +keep_warnings = True # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False |