]> git.ipfire.org Git - thirdparty/qemu.git/commit
docs/qapi-domain: add qapi:module directive
authorJohn Snow <jsnow@redhat.com>
Tue, 11 Mar 2025 03:42:09 +0000 (23:42 -0400)
committerMarkus Armbruster <armbru@redhat.com>
Tue, 11 Mar 2025 09:07:03 +0000 (10:07 +0100)
commit7320feeb9663c2fba1f70ed263f4c18080c75e3e
tree2065d690ea12a5c3db65651b409a217bf2470882
parent1ea664862ad097f25d722c1c733d16c5b971e99b
docs/qapi-domain: add qapi:module directive

This adds the qapi:module directive, which just notes the current module
being documented and performs a nested parse of the content block, if
present.

This code is based pretty heavily on Sphinx's PyModule directive, but
with unnecessary features excised.

For example:

.. qapi:module:: block-core

   Hello, and welcome to block-core!
   =================================

   lorem ipsum, dolor sit amet ...

Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250311034303.75779-12-jsnow@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
docs/sphinx/qapi_domain.py