qemu/docs/conf.py

1 # -*- coding: utf-8 -*-
4 # sphinx-quickstart on Thu Jan 31 16:40:14 2019.
7 # (1) as a common config file which is included by the conf.py
8 # for each of QEMU's manuals: in this case sphinx-build is run multiple
10 # (2) as a top level conf file which will result in building all
11 # the manuals into a single document: in this case sphinx-build is
12 # run once, on the top-level docs directory.
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 ------------------------------------------------
77 # source_suffix = ['.rst', '.md']
78 source_suffix = '.rst'
83 # Interpret `single-backticks` to be a cross-reference to any kind of
99 # the Makefile will pass version and release on the sphinx-build
135 # The rst_epilog fragment is effectively included in every rST file.
142 # We slurp in the defs.rst.inc and literally include it into rst_epilog,
145 # documents and for both via-make and direct sphinx-build invocation.
146 with open(os.path.join(qemu_docdir, 'defs.rst.inc')) as f:
149 # -- Options for HTML output ----------------------------------------------
163 # Theme options are theme-specific and customize the look and feel of a theme
178 html_static_path = [os.path.join(qemu_docdir, "sphinx-static")]
190     "gitlab_user": "qemu-project",
200 # Don't copy the rST source files to the HTML output directory,
204 # -- Options for HTMLHelp output ------------------------------------------
210 # -- Options for LaTeX output ---------------------------------------------
239 # -- Options for manual page output ---------------------------------------
240 # Individual manual/conf.py can override this to create man pages
242     ('interop/qemu-ga', 'qemu-ga',
245     ('interop/qemu-ga-ref', 'qemu-ga-ref',
248     ('interop/qemu-qmp-ref', 'qemu-qmp-ref',
251     ('interop/qemu-storage-daemon-qmp-ref', 'qemu-storage-daemon-qmp-ref',
254     ('system/qemu-manpage', 'qemu',
257     ('system/qemu-block-drivers', 'qemu-block-drivers',
260     ('system/qemu-cpu-models', 'qemu-cpu-models',
263     ('tools/qemu-img', 'qemu-img',
266     ('tools/qemu-nbd', 'qemu-nbd',
269     ('tools/qemu-pr-helper', 'qemu-pr-helper',
272     ('tools/qemu-storage-daemon', 'qemu-storage-daemon',
275     ('tools/qemu-trace-stap', 'qemu-trace-stap',
282 # sphinx-build from anywhere and the kerneldoc extension can still
284 kerneldoc_bin = ['perl', os.path.join(qemu_docdir, '../scripts/kernel-doc')]