docs/testing/user/configguide/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Functest Installation Guide documentation build configuration file, created
   4 # by sphinx-quickstart on Tue Apr  3 03:51:57 2018.
   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 import sphinx_opnfv_theme
  23
  24
  25 # -- General configuration ------------------------------------------------
  26
  27 # If your documentation needs a minimal Sphinx version, state it here.
  28 #
  29 # needs_sphinx = '1.0'
  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'Functest Installation Guide'
  50 copyright = u'2018, Functest <opnfv-tech-discuss@lists.opnfv.org>'
  51 author = u'Functest <opnfv-tech-discuss@lists.opnfv.org>'
  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'master'
  59 # The full version, including alpha/beta/rc tags.
  60 release = u'master'
  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 = []
  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
  81 # -- Options for HTML output ----------------------------------------------
  82
  83 # The theme to use for HTML and HTML Help pages.  See the documentation for
  84 # a list of builtin themes.
  85 #
  86 html_theme = 'opnfv'
  87
  88 # Theme options are theme-specific and customize the look and feel of a theme
  89 # further.  For a list of options available for each theme, see the
  90 # documentation.
  91 #
  92 # html_theme_options = {}
  93 html_theme_options = {
  94     'bootswatch_theme': 'journal',
  95     'navbar_sidebarrel': False,
  96     'navbar_title': '',
  97 }
  98
  99 # Add any paths that contain custom themes here, relative to this directory.
 100 # html_theme_path = []
 101 html_theme_path = sphinx_opnfv_theme.get_html_theme_path()
 102
 103 # Add any paths that contain custom static files (such as style sheets) here,
 104 # relative to this directory. They are copied after the builtin static files,
 105 # so a file named "default.css" will overwrite the builtin "default.css".
 106 # html_static_path = []
 107
 108 # Custom sidebar templates, must be a dictionary that maps document names
 109 # to template names.
 110 #
 111 # This is required for the alabaster theme
 112 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
 113 html_sidebars = {
 114     '**': [
 115         'relations.html',  # needs 'show_related': True theme option to display
 116         'searchbox.html',
 117     ]
 118 }
 119
 120
 121 # -- Options for HTMLHelp output ------------------------------------------
 122
 123 # Output file base name for HTML help builder.
 124 htmlhelp_basename = 'FunctestInstallationGuidedoc'
 125
 126
 127 # -- Options for LaTeX output ---------------------------------------------
 128
 129 latex_elements = {
 130     # The paper size ('letterpaper' or 'a4paper').
 131     #
 132     # 'papersize': 'letterpaper',
 133
 134     # The font size ('10pt', '11pt' or '12pt').
 135     #
 136     # 'pointsize': '10pt',
 137
 138     # Additional stuff for the LaTeX preamble.
 139     #
 140     # 'preamble': '',
 141
 142     # Latex figure (float) alignment
 143     #
 144     # 'figure_align': 'htbp',
 145 }
 146
 147 # Grouping the document tree into LaTeX files. List of tuples
 148 # (source start file, target name, title,
 149 #  author, documentclass [howto, manual, or own class]).
 150 latex_documents = [
 151     (master_doc,
 152      'FunctestInstallationGuide.tex',
 153      u'Functest Installation Guide Documentation',
 154      u'Functest \\textless{}opnfv-tech-discuss@lists.opnfv.org\\textgreater{}',
 155      'manual'),
 156 ]
 157
 158
 159 # -- Options for manual page output ---------------------------------------
 160
 161 # One entry per manual page. List of tuples
 162 # (source start file, name, description, authors, manual section).
 163 man_pages = [
 164     (master_doc,
 165      'functestinstallationguide',
 166      u'Functest Installation Guide Documentation',
 167      [author],
 168      1)
 169 ]
 170
 171
 172 # -- Options for Texinfo output -------------------------------------------
 173
 174 # Grouping the document tree into Texinfo files. List of tuples
 175 # (source start file, target name, title, author,
 176 #  dir menu entry, description, category)
 177 texinfo_documents = [
 178     (master_doc,
 179      'FunctestInstallationGuide',
 180      u'Functest Installation Guide Documentation',
 181      author,
 182      'FunctestInstallationGuide',
 183      'One line description of project.',
 184      'Miscellaneous'),
 185 ]