qemu/docs/sphinx
John Snow a5635d6181 qapi/qapidoc: add rendering for INTRO sections
Amend the qapidoc generator to handle and render INTRO sections.

The only real difference here from other sections is that we need to
dedent the text so it renders correctly. Members and Features are also
indented, but do not require a dedent() because they are always used
in tandem with an rST construct that forms the start of a new indented
block; there is coincidental harmony.

Plaintext sections, however, do not start their own block and thus
need to be dedented to prevent accidentally rendering them as a
blockquote or a syntax error.

This dedent transformation on the text does not reflow the text, so
source line information remains accurate, and the "blame" chain of
custody for sphinx rST parsing error messages continues to be correct
even through this transformation.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20260611042332.482979-13-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Commit message tweaked]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
2026-06-16 15:36:01 +02:00
..
compat.py docs/qapi-domain: Fix error context reporting in Sphinx 5.x and 6.x 2025-03-11 10:10:57 +01:00
dbusdoc.py docs/sphinx: add sphinx modules to include D-Bus documentation 2021-12-21 10:50:21 +04:00
dbusdomain.py meson: Pass -j option to sphinx 2023-05-18 08:53:50 +02:00
dbusparser.py docs/sphinx: add sphinx modules to include D-Bus documentation 2021-12-21 10:50:21 +04:00
depfile.py docs/sphinx: include kernel-doc script as a dependency 2025-01-17 10:45:38 +00:00
fakedbusdoc.py meson: Pass -j option to sphinx 2023-05-18 08:53:50 +02:00
hxtool.py docs: remove Sphinx 1.x compatibility code 2024-07-12 16:46:21 -04:00
kerneldoc.py scripts/kerneldoc: Switch to the Python kernel-doc script 2025-08-30 16:37:23 +01:00
qapi_domain.py docs/qapi-domain: add return-nodesc 2025-07-14 12:02:58 +02:00
qapidoc.py qapi/qapidoc: add rendering for INTRO sections 2026-06-16 15:36:01 +02:00
qmp_lexer.py docs/sphinx/qmp_lexer: Highlight elisions like comments, not prompts 2025-04-08 09:04:34 +02:00