summary refs log tree commit diff stats
path: root/docs/interop
diff options
context:
space:
mode:
authorJohn Snow <jsnow@redhat.com>2025-06-18 12:53:52 -0400
committerMarkus Armbruster <armbru@redhat.com>2025-07-14 10:08:27 +0200
commit6c10778826a873b9012d95e63298a6f879debcaa (patch)
tree9707775416b8a85c047ef42facefb1c42eb1a3bd /docs/interop
parent8d789c8cdb8de2cae39f217b6c9607ac9c036c8c (diff)
downloadfocaccia-qemu-6c10778826a873b9012d95e63298a6f879debcaa.tar.gz
focaccia-qemu-6c10778826a873b9012d95e63298a6f879debcaa.zip
docs/sphinx: remove special parsing for freeform sections
Remove the QAPI doc section heading syntax, use plain rST section
headings instead.

Tests and documentation are updated to match.

Interestingly, Plain rST headings work fine before this patch, except
for over- and underlining with '=', which the doc parser rejected as
invalid QAPI doc section heading in free-form comments.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250618165353.1980365-5-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Add more detail to commit message]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'docs/interop')
-rw-r--r--docs/interop/firmware.json4
-rw-r--r--docs/interop/vhost-user.json4
2 files changed, 6 insertions, 2 deletions
diff --git a/docs/interop/firmware.json b/docs/interop/firmware.json
index 745d21d822..f46fdedfa8 100644
--- a/docs/interop/firmware.json
+++ b/docs/interop/firmware.json
@@ -11,7 +11,9 @@
 # later. See the COPYING file in the top-level directory.
 
 ##
-# = Firmware
+# ********
+# Firmware
+# ********
 ##
 
 { 'pragma': {
diff --git a/docs/interop/vhost-user.json b/docs/interop/vhost-user.json
index b6ade9e493..095eb99cf7 100644
--- a/docs/interop/vhost-user.json
+++ b/docs/interop/vhost-user.json
@@ -10,7 +10,9 @@
 # later. See the COPYING file in the top-level directory.
 
 ##
-# = vhost user backend discovery & capabilities
+# *******************************************
+# vhost user backend discovery & capabilities
+# *******************************************
 ##
 
 ##