docs/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # QEMU documentation build configuration file, created by
   4 # sphinx-quickstart on Thu Jan 31 16:40:14 2019.
   5 #
   6 # This file is execfile()d with the current directory set to its
   7 # containing dir.
   8 #
   9 # Note that not all possible configuration values are present in this
  10 # autogenerated file.
  11 #
  12 # All configuration values have a default; values that are commented out
  13 # serve to show the default.
  14
  15 # If extensions (or modules to document with autodoc) are in another directory,
  16 # add these directories to sys.path here. If the directory is relative to the
  17 # documentation root, use os.path.abspath to make it absolute, like shown here.
  18 #
  19 # import os
  20 # import sys
  21 # sys.path.insert(0, os.path.abspath('.'))
  22
  23
  24 # -- General configuration ------------------------------------------------
  25
  26 # If your documentation needs a minimal Sphinx version, state it here.
  27 #
  28 # needs_sphinx = '1.0'
  29
  30 # Add any Sphinx extension module names here, as strings. They can be
  31 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  32 # ones.
  33 extensions = []
  34
  35 # Add any paths that contain templates here, relative to this directory.
  36 templates_path = ['_templates']
  37
  38 # The suffix(es) of source filenames.
  39 # You can specify multiple suffix as a list of string:
  40 #
  41 # source_suffix = ['.rst', '.md']
  42 source_suffix = '.rst'
  43
  44 # The master toctree document.
  45 master_doc = 'index'
  46
  47 # General information about the project.
  48 project = u'QEMU'
  49 copyright = u'2019, The QEMU Project Developers'
  50 author = u'The QEMU Project Developers'
  51
  52 # The version info for the project you're documenting, acts as replacement for
  53 # |version| and |release|, also used in various other places throughout the
  54 # built documents.
  55 #
  56 # The short X.Y version.
  57 version = u'4.0'
  58 # The full version, including alpha/beta/rc tags.
  59 release = u'4.0'
  60
  61 # The language for content autogenerated by Sphinx. Refer to documentation
  62 # for a list of supported languages.
  63 #
  64 # This is also used if you do content translation via gettext catalogs.
  65 # Usually you set "language" from the command line for these cases.
  66 language = None
  67
  68 # List of patterns, relative to source directory, that match files and
  69 # directories to ignore when looking for source files.
  70 # This patterns also effect to html_static_path and html_extra_path
  71 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
  72
  73 # The name of the Pygments (syntax highlighting) style to use.
  74 pygments_style = 'sphinx'
  75
  76 # If true, `todo` and `todoList` produce output, else they produce nothing.
  77 todo_include_todos = False
  78
  79
  80 # -- Options for HTML output ----------------------------------------------
  81
  82 # The theme to use for HTML and HTML Help pages.  See the documentation for
  83 # a list of builtin themes.
  84 #
  85 html_theme = 'alabaster'
  86
  87 # Theme options are theme-specific and customize the look and feel of a theme
  88 # further.  For a list of options available for each theme, see the
  89 # documentation.
  90 #
  91 # html_theme_options = {}
  92
  93 # Add any paths that contain custom static files (such as style sheets) here,
  94 # relative to this directory. They are copied after the builtin static files,
  95 # so a file named "default.css" will overwrite the builtin "default.css".
  96 # QEMU doesn't yet have any static files, so comment this out so we don't
  97 # get a warning about a missing directory.
  98 # If we do ever add this then it would probably be better to call the
  99 # subdirectory sphinx_static, as the Linux kernel does.
 100 # html_static_path = ['_static']
 101
 102 # Custom sidebar templates, must be a dictionary that maps document names
 103 # to template names.
 104 #
 105 # This is required for the alabaster theme
 106 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
 107 html_sidebars = {
 108     '**': [
 109         'relations.html',  # needs 'show_related': True theme option to display
 110         'searchbox.html',
 111     ]
 112 }
 113
 114
 115 # -- Options for HTMLHelp output ------------------------------------------
 116
 117 # Output file base name for HTML help builder.
 118 htmlhelp_basename = 'QEMUdoc'
 119
 120
 121 # -- Options for LaTeX output ---------------------------------------------
 122
 123 latex_elements = {
 124     # The paper size ('letterpaper' or 'a4paper').
 125     #
 126     # 'papersize': 'letterpaper',
 127
 128     # The font size ('10pt', '11pt' or '12pt').
 129     #
 130     # 'pointsize': '10pt',
 131
 132     # Additional stuff for the LaTeX preamble.
 133     #
 134     # 'preamble': '',
 135
 136     # Latex figure (float) alignment
 137     #
 138     # 'figure_align': 'htbp',
 139 }
 140
 141 # Grouping the document tree into LaTeX files. List of tuples
 142 # (source start file, target name, title,
 143 #  author, documentclass [howto, manual, or own class]).
 144 latex_documents = [
 145     (master_doc, 'QEMU.tex', u'QEMU Documentation',
 146      u'The QEMU Project Developers', 'manual'),
 147 ]
 148
 149
 150 # -- Options for manual page output ---------------------------------------
 151
 152 # One entry per manual page. List of tuples
 153 # (source start file, name, description, authors, manual section).
 154 man_pages = [
 155     (master_doc, 'qemu', u'QEMU Documentation',
 156      [author], 1)
 157 ]
 158
 159
 160 # -- Options for Texinfo output -------------------------------------------
 161
 162 # Grouping the document tree into Texinfo files. List of tuples
 163 # (source start file, target name, title, author,
 164 #  dir menu entry, description, category)
 165 texinfo_documents = [
 166     (master_doc, 'QEMU', u'QEMU Documentation',
 167      author, 'QEMU', 'One line description of project.',
 168      'Miscellaneous'),
 169 ]
 170
 171
 172