Skip to content

Commit d3c8df8

Browse files
committed
docs: Add note about debug output requiring keep_warnings
1 parent 44f2586 commit d3c8df8

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

docs/tmpl.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -395,6 +395,12 @@ Enable the debug option to see a detailed report when troubleshooting templates:
395395
This is especially useful when a template fails due to an undefined variable,
396396
unexpected data shape, or invalid generated markup.
397397

398+
.. note::
399+
400+
Debug output (``nodes.system_message``) is emitted via Sphinx's warning system,
401+
so it only appears in the built document when :confval:`keep_warnings` is set
402+
to ``True`` in your ``conf.py``.
403+
398404
Some Technical Details
399405
======================
400406

0 commit comments

Comments
 (0)