Commit 47d6d752 authored Jul 19, 2016 by Daniel Vetter Committed by Jonathan Corbet Jul 19, 2016

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>

parent e6507a00

Documentation/conf.py

+1 −1

Original line number	Diff line number	Diff line
		@@ -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

Admin message