qemu/docs/conf.py

1 # -*- coding: utf-8 -*-
3 # QEMU documentation build configuration file, created by
4 # sphinx-quickstart on Thu Jan 31 16:40:14 2019.
8 # for each of QEMU's manuals: in this case sphinx-build is run multiple
11 # the manuals into a single document: in this case sphinx-build is
12 # run once, on the top-level docs directory.
14 # QEMU's makefiles take option (1), which allows us to install
16 # to ship the 'devel' manual to end-users).
17 # Third-party sites such as readthedocs.org will take option (2).
34 # The per-manual conf.py will set qemu_docdir for a single-manual build;
35 # otherwise set it here if this is an entire-manual-set build.
52 # -- General configuration ------------------------------------------------
90 # Interpret `single-backticks` to be a cross-reference to any kind of
95 # General information about the project.
96 project = u'QEMU'  variable
97 copyright = u'2025, The QEMU Project Developers'
98 author = u'The QEMU Project Developers'
100 # The version info for the project you're documenting, acts as replacement for
106 # the Makefile will pass version and release on the sphinx-build
143 ver_machine_deprecation_version = "%d.%d.0" % (major - 3, minor)
144 ver_machine_deletion_version = "%d.%d.0" % (major - 6, minor)
173 confdir = os.getenv('CONFDIR', "/etc/qemu")
189 # documents and for both via-make and direct sphinx-build invocation.
209 # -- Options for HTML output ----------------------------------------------
223 # Theme options are theme-specific and customize the look and feel of a theme
238 html_static_path = [os.path.join(qemu_docdir, "sphinx-static")]
249     "source_url_prefix": "https://gitlab.com/qemu-project/qemu/-/blob/master/docs/",
250     "gitlab_user": "qemu-project",
251     "gitlab_repo": "qemu",
264 # -- Options for HTMLHelp output ------------------------------------------
270 # -- Options for LaTeX output ---------------------------------------------
294     (master_doc, 'QEMU.tex', u'QEMU Documentation',
295      u'The QEMU Project Developers', 'manual'),
299 # -- Options for manual page output ---------------------------------------
302     ('interop/qemu-ga', 'qemu-ga',
303      'QEMU Guest Agent',
305     ('interop/qemu-ga-ref', 'qemu-ga-ref',
306      'QEMU Guest Agent Protocol Reference',
308     ('interop/qemu-qmp-ref', 'qemu-qmp-ref',
309      'QEMU QMP Reference Manual',
311     ('interop/qemu-storage-daemon-qmp-ref', 'qemu-storage-daemon-qmp-ref',
312      'QEMU Storage Daemon QMP Reference Manual',
314     ('system/qemu-manpage', 'qemu',
315      'QEMU User Documentation',
317     ('system/qemu-block-drivers', 'qemu-block-drivers',
318      'QEMU block drivers reference',
319      ['Fabrice Bellard and the QEMU Project developers'], 7),
320     ('system/qemu-cpu-models', 'qemu-cpu-models',
321      'QEMU CPU Models',
322      ['The QEMU Project developers'], 7),
323     ('tools/qemu-img', 'qemu-img',
324      'QEMU disk image utility',
326     ('tools/qemu-nbd', 'qemu-nbd',
327      'QEMU Disk Network Block Device Server',
329     ('tools/qemu-pr-helper', 'qemu-pr-helper',
330      'QEMU persistent reservation helper',
332     ('tools/qemu-storage-daemon', 'qemu-storage-daemon',
333      'QEMU storage daemon',
335     ('tools/qemu-trace-stap', 'qemu-trace-stap',
336      'QEMU SystemTap trace tool',
342 # sphinx-build from anywhere and the kerneldoc extension can still
344 kerneldoc_bin = ['perl', os.path.join(qemu_docdir, '../scripts/kernel-doc')]
349 dbus_index_common_prefix = ["org.qemu."]