aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDaniel Vetter <daniel.vetter@ffwll.ch>2016-07-19 07:42:54 -0400
committerJonathan Corbet <corbet@lwn.net>2016-07-19 18:22:20 -0400
commit47d6d752b9e20dbe8a2acd22e887be81a6f39de9 (patch)
tree33e4ef3143f359c5b2d5ac74c74465ced6e70593
parente6507a00fd08986ce003012a10af78cc7e47eee8 (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>
-rw-r--r--Documentation/conf.py2
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'
125#modindex_common_prefix = [] 125#modindex_common_prefix = []
126 126
127# If true, keep warnings as "system message" paragraphs in the built documents. 127# If true, keep warnings as "system message" paragraphs in the built documents.
128#keep_warnings = False 128keep_warnings = True
129 129
130# If true, `todo` and `todoList` produce output, else they produce nothing. 130# If true, `todo` and `todoList` produce output, else they produce nothing.
131todo_include_todos = False 131todo_include_todos = False