1 # -*- coding: utf-8 -*-
3 # Functest Installation Guide documentation build configuration file, created
4 # by sphinx-quickstart on Tue Apr 3 03:51:57 2018.
6 # This file is execfile()d with the current directory set to its
9 # Note that not all possible configuration values are present in this
12 # All configuration values have a default; values that are commented out
13 # serve to show the default.
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.
21 # sys.path.insert(0, os.path.abspath('.'))
23 # -- General configuration ------------------------------------------------
25 # If your documentation needs a minimal Sphinx version, state it here.
27 # needs_sphinx = '1.0'
29 # Add any Sphinx extension module names here, as strings. They can be
30 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
34 # Add any paths that contain templates here, relative to this directory.
35 templates_path = ['_templates']
37 # The suffix(es) of source filenames.
38 # You can specify multiple suffix as a list of string:
40 # source_suffix = ['.rst', '.md']
41 source_suffix = '.rst'
43 # The master toctree document.
46 # General information about the project.
47 project = u'Functest Installation Guide'
48 copyright = u'2018, Functest <opnfv-tech-discuss@lists.opnfv.org>'
49 author = u'Functest <opnfv-tech-discuss@lists.opnfv.org>'
51 # The version info for the project you're documenting, acts as replacement for
52 # |version| and |release|, also used in various other places throughout the
55 # The short X.Y version.
57 # The full version, including alpha/beta/rc tags.
60 # The language for content autogenerated by Sphinx. Refer to documentation
61 # for a list of supported languages.
63 # This is also used if you do content translation via gettext catalogs.
64 # Usually you set "language" from the command line for these cases.
67 # List of patterns, relative to source directory, that match files and
68 # directories to ignore when looking for source files.
69 # This patterns also effect to html_static_path and html_extra_path
72 # The name of the Pygments (syntax highlighting) style to use.
73 pygments_style = 'sphinx'
75 # If true, `todo` and `todoList` produce output, else they produce nothing.
76 todo_include_todos = False
79 # -- Options for HTML output ----------------------------------------------
81 # The theme to use for HTML and HTML Help pages. See the documentation for
82 # a list of builtin themes.
84 html_theme = 'sphinx_rtd_theme'
86 # Theme options are theme-specific and customize the look and feel of a theme
87 # further. For a list of options available for each theme, see the
90 # html_theme_options = {}
92 # Add any paths that contain custom themes here, relative to this directory.
93 # html_theme_path = []
95 # Add any paths that contain custom static files (such as style sheets) here,
96 # relative to this directory. They are copied after the builtin static files,
97 # so a file named "default.css" will overwrite the builtin "default.css".
98 # html_static_path = []
100 # Custom sidebar templates, must be a dictionary that maps document names
103 # This is required for the alabaster theme
104 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
107 'relations.html', # needs 'show_related': True theme option to display
113 # -- Options for HTMLHelp output ------------------------------------------
115 # Output file base name for HTML help builder.
116 htmlhelp_basename = 'FunctestInstallationGuidedoc'
119 # -- Options for LaTeX output ---------------------------------------------
122 # The paper size ('letterpaper' or 'a4paper').
124 # 'papersize': 'letterpaper',
126 # The font size ('10pt', '11pt' or '12pt').
128 # 'pointsize': '10pt',
130 # Additional stuff for the LaTeX preamble.
134 # Latex figure (float) alignment
136 # 'figure_align': 'htbp',
139 # Grouping the document tree into LaTeX files. List of tuples
140 # (source start file, target name, title,
141 # author, documentclass [howto, manual, or own class]).
144 'FunctestInstallationGuide.tex',
145 u'Functest Installation Guide Documentation',
146 u'Functest \\textless{}opnfv-tech-discuss@lists.opnfv.org\\textgreater{}',
151 # -- Options for manual page output ---------------------------------------
153 # One entry per manual page. List of tuples
154 # (source start file, name, description, authors, manual section).
157 'functestinstallationguide',
158 u'Functest Installation Guide Documentation',
164 # -- Options for Texinfo output -------------------------------------------
166 # Grouping the document tree into Texinfo files. List of tuples
167 # (source start file, target name, title, author,
168 # dir menu entry, description, category)
169 texinfo_documents = [
171 'FunctestInstallationGuide',
172 u'Functest Installation Guide Documentation',
174 'FunctestInstallationGuide',
175 'One line description of project.',