John Snow 7320feeb96 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>

2025-03-11 10:07:03 +01:00

..

_templates

docs: Add QEMU version information to HTML footer

2021-07-18 10:59:47 +01:00

about

vfio queue:

2025-03-07 07:39:21 +08:00

config

vl: recognize audiodev groups in configuration files

2023-09-22 17:35:11 +02:00

devel

* scripts: dump stdin on meson-buildoptions error

2025-03-10 13:40:05 +08:00

interop

docs/devel: add a codebase section

2025-01-17 10:45:49 +00:00

specs

docs/specs: Add aspeed-intc

2025-03-09 14:36:53 +01:00

sphinx

docs/qapi-domain: add qapi:module directive

2025-03-11 10:07:03 +01:00

sphinx-static

docs/sphinx: add CSS styling for qmp-example directive

2024-07-17 10:20:53 +02:00

spin

docs: create config/, devel/ and spin/ subdirectories

2017-06-07 18:22:03 +02:00

system

hw/vmapple/vmapple: Add vmapple machine type

2025-03-04 14:45:34 +01:00

tools

qemu-nbd: Allow users to adjust handshake limit

2025-02-11 13:45:46 -06:00

user

docs/user: Document the %d placeholder and suspend=n QEMU_GDB features

2025-02-10 13:47:59 +00:00

block-replication.txt

docs/block-replication.txt: Fix replication top-id command demo

2021-12-17 11:35:00 +01:00

bypass-iommu.txt

docs: Add documentation for iommu bypass

2021-07-16 11:10:45 -04:00

COLO-FT.txt

chardev: finalize 'reconnect' deprecation

2024-10-28 14:37:25 +08:00

colo-proxy.txt

colo: examples: remove mentions of script= and (wrong) downscript=

2024-01-30 21:20:20 +03:00

conf.py

docs/sphinx: create QAPI domain extension stub

2025-03-11 10:07:02 +01:00

defs.rst.inc

docs: Fix typo in the default name of the qemu-system-x86_64 binary

2021-04-01 14:28:39 +02:00

glossary.rst

docs: add a glossary

2025-01-17 10:45:54 +00:00

igd-assign.txt

vfio/pci: Add IGD documentation

2016-05-26 11:12:05 -06:00

image-fuzzer.txt

docs: Render binary names as monospaced text

2021-11-22 15:02:38 +01:00

index.rst

docs: add a glossary

2025-01-17 10:45:54 +00:00

memory-hotplug.txt

docs: Grammar and spelling fixes

2018-07-13 10:16:04 +01:00

meson.build

9p: remove 'proxy' filesystem backend driver

2024-10-03 19:33:25 +02:00

multi-thread-compression.txt

docs tests: Fix use of migrate_set_parameter

2023-09-08 13:08:52 +03:00

multiseat.txt

docs: Spell QEMU all caps

2021-11-19 10:16:58 +01:00

nvdimm.txt

docs/nvdimm: Update nvdimm option value in machine example

2021-09-27 10:57:21 +02:00

pci_expander_bridge.txt

docs, tests: do not specify scsi=off

2024-06-05 11:00:56 +02:00

pcie_pci_bridge.txt

docs: add slot when adding new PCIe root port

2021-07-03 03:12:35 -04:00

pcie_sriov.txt

pcie_sriov: Ensure VF addr does not overflow

2025-02-20 18:23:19 -05:00

pcie.txt

docs/pcie.txt: Replace ioh3420 with pcie-root-port

2023-01-28 06:21:30 -05:00

qcow2-cache.txt

qcow2: Document the Extended L2 Entries feature

2020-08-25 08:33:20 +02:00

qdev-device-use.txt

util: remove support -chardev tty and -chardev parport

2023-01-06 00:51:02 +01:00

qemu-option-trace.rst.inc

qemu-option-trace.rst.inc: Don't use option:: markup

2020-11-02 16:52:18 +00:00

qemupciserial.inf

docs: Grammar and spelling fixes

2018-07-13 10:16:04 +01:00

rdma.txt

docs tests: Fix use of migrate_set_parameter

2023-09-08 13:08:52 +03:00

requirements.txt

pythondeps.toml: warn about updates needed to docs/requirements.txt

2024-04-23 17:35:26 +02:00

spice-port-fqdn.txt

docs: add spice-port-fqdn.txt

2012-12-17 14:01:41 +01:00

throttle.txt

docs: Drop deprecated 'props' from object-add

2021-11-22 15:02:38 +01:00

xbzrle.txt

migrate: remove QMP/HMP commands for speed, downtime and cache size

2021-03-18 09:22:55 +00:00

xen-save-devices-state.txt

Fix up dangling references to qmp-commands.* in comment and doc

2018-03-02 13:48:26 -06:00