summary refs log tree commit diff stats
path: root/docs/conf.py
diff options
context:
space:
mode:
authorJohn Snow <jsnow@redhat.com>2025-03-10 23:42:01 -0400
committerMarkus Armbruster <armbru@redhat.com>2025-03-11 10:07:02 +0100
commitecf92e3618ab6e6cd7ae151f9c12b9e2a6ead198 (patch)
tree457aa163c98fe68ab4344e28e32af2e9f21c9754 /docs/conf.py
parent825b96dbcee23d134b691fc75618b59c5f53da32 (diff)
downloadfocaccia-qemu-ecf92e3618ab6e6cd7ae151f9c12b9e2a6ead198.tar.gz
focaccia-qemu-ecf92e3618ab6e6cd7ae151f9c12b9e2a6ead198.zip
docs/sphinx: create QAPI domain extension stub
A Sphinx domain is a collection of directive and role extensions meant
to facilitate the documentation of a specific language. For instance,
Sphinx ships with "python" and "cpp" domains. This patch introduces a
stub for the "qapi" language domain.

Please see https://www.sphinx-doc.org/en/master/usage/domains/index.html
for more information.

This stub doesn't really do anything yet, we'll get to it brick-by-brick
in the forthcoming commits to keep the series breezy and the git history
informative.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250311034303.75779-4-jsnow@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py9
1 files changed, 8 insertions, 1 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 31bb9a3789..49d9de894c 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -60,7 +60,14 @@ needs_sphinx = '3.4.3'
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['kerneldoc', 'qmp_lexer', 'hxtool', 'depfile', 'qapidoc']
+extensions = [
+    'depfile',
+    'hxtool',
+    'kerneldoc',
+    'qapi_domain',
+    'qapidoc',
+    'qmp_lexer',
+]
 
 if sphinx.version_info[:3] > (4, 0, 0):
     tags.add('sphinx4')