docs/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Functest 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
  23 # -- General configuration ------------------------------------------------
  24
  25 # If your documentation needs a minimal Sphinx version, state it here.
  26 #
  27 # needs_sphinx = '1.0'
  28
  29 # Add any Sphinx extension module names here, as strings. They can be
  30 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  31 # ones.
  32 extensions = []
  33
  34 # Add any paths that contain templates here, relative to this directory.
  35 templates_path = ['_templates']
  36
  37 # The suffix(es) of source filenames.
  38 # You can specify multiple suffix as a list of string:
  39 #
  40 # source_suffix = ['.rst', '.md']
  41 source_suffix = '.rst'
  42
  43 # The master toctree document.
  44 master_doc = 'index'
  45
  46 # General information about the project.
  47 project = u'Functest'
  48 copyright = u'2018, Functest <opnfv-tech-discuss@lists.opnfv.org>'
  49 author = u'Functest <opnfv-tech-discuss@lists.opnfv.org>'
  50
  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
  53 # built documents.
  54 #
  55 # The short X.Y version.
  56 version = u'master'
  57 # The full version, including alpha/beta/rc tags.
  58 release = u'master'
  59
  60 # The language for content autogenerated by Sphinx. Refer to documentation
  61 # for a list of supported languages.
  62 #
  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.
  65 language = None
  66
  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
  70 exclude_patterns = []
  71
  72 # The name of the Pygments (syntax highlighting) style to use.
  73 pygments_style = 'sphinx'
  74
  75 # If true, `todo` and `todoList` produce output, else they produce nothing.
  76 todo_include_todos = False
  77
  78
  79 # -- Options for HTML output ----------------------------------------------
  80
  81 # The theme to use for HTML and HTML Help pages.  See the documentation for
  82 # a list of builtin themes.
  83 #
  84 html_theme = 'sphinx_rtd_theme'
  85
  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
  88 # documentation.
  89 #
  90 # html_theme_options = {}
  91
  92 # Add any paths that contain custom themes here, relative to this directory.
  93 # html_theme_path = []
  94
  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 = []
  99
 100 # Custom sidebar templates, must be a dictionary that maps document names
 101 # to template names.
 102 #
 103 # This is required for the alabaster theme
 104 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
 105 html_sidebars = {
 106     '**': [
 107         'relations.html',  # needs 'show_related': True theme option to display
 108         'searchbox.html',
 109     ]
 110 }
 111
 112
 113 # -- Options for HTMLHelp output ------------------------------------------
 114
 115 # Output file base name for HTML help builder.
 116 htmlhelp_basename = 'Functestdoc'
 117
 118
 119 # -- Options for LaTeX output ---------------------------------------------
 120
 121 latex_elements = {
 122     # The paper size ('letterpaper' or 'a4paper').
 123     #
 124     # 'papersize': 'letterpaper',
 125
 126     # The font size ('10pt', '11pt' or '12pt').
 127     #
 128     # 'pointsize': '10pt',
 129
 130     # Additional stuff for the LaTeX preamble.
 131     #
 132     # 'preamble': '',
 133
 134     # Latex figure (float) alignment
 135     #
 136     # 'figure_align': 'htbp',
 137 }
 138
 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]).
 142 latex_documents = [
 143     (master_doc,
 144      'Functest.tex',
 145      u'Functest Documentation',
 146      u'Functest \\textless{}opnfv-tech-discuss@lists.opnfv.org\\textgreater{}',
 147      'manual'),
 148 ]
 149
 150
 151 # -- Options for manual page output ---------------------------------------
 152
 153 # One entry per manual page. List of tuples
 154 # (source start file, name, description, authors, manual section).
 155 man_pages = [
 156     (master_doc,
 157      'functest',
 158      u'Functest Documentation',
 159      [author],
 160      1)
 161 ]
 162
 163
 164 # -- Options for Texinfo output -------------------------------------------
 165
 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 = [
 170     (master_doc,
 171      'Functest',
 172      u'Functest Documentation',
 173      author,
 174      'Functest',
 175      'One line description of project.',
 176      'Miscellaneous'),
 177 ]
 178
 179 spelling_word_list_filename = 'spelling_wordlist.txt'