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