Skip to content

Commit 47d6d75

Browse files
danvetJonathan Corbet
authored andcommitted
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 <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Signed-off-by: Daniel Vetter <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
1 parent e6507a0 commit 47d6d75

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

Documentation/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@
125125
#modindex_common_prefix = []
126126

127127
# If true, keep warnings as "system message" paragraphs in the built documents.
128-
#keep_warnings = False
128+
keep_warnings = True
129129

130130
# If true, `todo` and `todoList` produce output, else they produce nothing.
131131
todo_include_todos = False

0 commit comments

Comments
 (0)