summary refs log tree commit diff stats
path: root/docs/sphinx-static
diff options
context:
space:
mode:
authorJohn Snow <jsnow@redhat.com>2024-07-16 22:13:06 -0400
committerMarkus Armbruster <armbru@redhat.com>2024-07-17 10:20:53 +0200
commit76e375fc3c538bd6e4232314f693b56536a50b73 (patch)
treebd38ddc489996edfa73977271ffba528d256e54c /docs/sphinx-static
parent547864f9d4cead4fe70981d2c4ffa5905b40e671 (diff)
downloadfocaccia-qemu-76e375fc3c538bd6e4232314f693b56536a50b73.tar.gz
focaccia-qemu-76e375fc3c538bd6e4232314f693b56536a50b73.zip
docs/qapidoc: add QMP highlighting to annotated qmp-example blocks
For any code literal blocks inside of a qmp-example directive, apply and
enforce the QMP lexer/highlighter to those blocks.

This way, you won't need to write:

```
.. qmp-example::
   :annotated:

   Blah blah

   .. code-block:: QMP

      -> { "lorem": "ipsum" }
```

But instead, simply:

```
.. qmp-example::
   :annotated:

   Blah blah::

     -> { "lorem": "ipsum" }
```

Once the directive block is exited, whatever the previous default
highlight language was will be restored; localizing the forced QMP
lexing to exclusively this directive.

Note, if the default language is *already* QMP, this directive will not
generate and restore redundant highlight configuration nodes. We may
well decide that the default language ought to be QMP for any QAPI
reference pages, but this way the directive behaves consistently no
matter where it is used.

Signed-off-by: John Snow <jsnow@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240717021312.606116-5-jsnow@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'docs/sphinx-static')
0 files changed, 0 insertions, 0 deletions