docs/conf.py

   1 import sphinx_bootstrap_theme
   2 import os
   3
   4 # If extensions (or modules to document with autodoc) are in another directory,
   5 # add these directories to sys.path here. If the directory is relative to the
   6 # documentation root, use os.path.abspath to make it absolute, like shown here.
   7 # -- General configuration ------------------------------------------------
   8
   9 # If your documentation needs a minimal Sphinx version, state it here.
  10 # needs_sphinx = '1.0'
  11 needs_sphinx = '1.3'
  12 # Add any Sphinx extension module names here, as strings. They can be
  13 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  14 # ones.
  15 extensions = ['sphinxcontrib.httpdomain', 'sphinx.ext.autodoc',
  16               'sphinx.ext.viewcode', 'sphinx.ext.napoleon',
  17               'sphinx.ext.intersphinx']
  18 # Disable javasphinx generation until we have a solution to long build
  19 # times. readthedocs timesout after 902 seconds.
  20
  21 # Add any paths that contain templates here, relative to this directory.
  22 templates_path = ['_templates']
  23
  24 # The suffix(es) of source filenames.
  25 # You can specify multiple suffix as a list of string:
  26 # source_suffix = ['.rst', '.md']
  27 source_suffix = '.rst'
  28
  29 # The encoding of source files.
  30 # source_encoding = 'utf-8-sig'
  31
  32 # The master toctree document.
  33 master_doc = 'index'
  34
  35 # General information about the project.
  36 project = ''
  37 copyright = '2020, OPNFV. Licensed under CC BY 4.0'
  38 author = 'Open Platform for NFV'
  39
  40 # The version info for the project you're documenting, acts as replacement for
  41 # |version| and |release|, also used in various other places throughout the
  42 # built documents.
  43 #
  44 # The short X.Y version.
  45 version = 'Latest'
  46 # The full version, including alpha/beta/rc tags.
  47 release = 'Latest'
  48 # The branch this project should link against for projects
  49 # following the stable-branch process. On the opnfvdocs stable branch
  50 # this should be set to 'stable/<release>' where '<release>' is the
  51 # current stable release (Ex: 'stable/gambia')
  52 branch = 'latest'
  53
  54 # The language for content autogenerated by Sphinx. Refer to documentation
  55 # for a list of supported languages.
  56 #
  57 # This is also used if you do content translation via gettext catalogs.
  58 # Usually you set "language" from the command line for these cases.
  59 language = None
  60
  61 # There are two options for replacing |today|: either, you set today to some
  62 # non-false value, then it is used:
  63 # today = ''
  64 # Else, today_fmt is used as the format for a strftime call.
  65 # today_fmt = '%B %d, %Y'
  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 = ['templates/*', 'how-to-use-docs/files/*', 'development/opnfvsecguide/*']
  71
  72 # The reST default role (used for this markup: `text`) to use for all
  73 # documents.
  74 # default_role = None
  75
  76 # If true, '()' will be appended to :func: etc. cross-reference text.
  77 # add_function_parentheses = True
  78
  79 # If true, the current module name will be prepended to all description
  80 # unit titles (such as .. function::).
  81 # add_module_names = True
  82
  83 # If true, sectionauthor and moduleauthor directives will be shown in the
  84 # output. They are ignored by default.
  85 # show_authors = False
  86
  87 # The name of the Pygments (syntax highlighting) style to use.
  88 pygments_style = 'sphinx'
  89
  90 # A list of ignored prefixes for module index sorting.
  91 # modindex_common_prefix = []
  92
  93 # If true, keep warnings as "system message" paragraphs in the built documents.
  94 # keep_warnings = False
  95
  96 # If true, `todo` and `todoList` produce output, else they produce nothing.
  97 todo_include_todos = False
  98
  99
 100 # -- Options for HTML output ----------------------------------------------
 101
 102 # The theme to use for HTML and HTML Help pages.  See the documentation for
 103 # a list of builtin themes.
 104 html_theme = 'bootstrap'
 105
 106 # Theme options are theme-specific and customize the look and feel of a theme
 107 # further.  For a list of options available for each theme, see the
 108 # documentation.
 109 # html_theme_options = {}
 110 html_theme_options = {
 111     'bootswatch_theme': "journal",
 112     'navbar_sidebarrel': False,
 113 }
 114
 115 # Add any paths that contain custom themes here, relative to this directory.
 116 # html_theme_path = []
 117 html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
 118
 119 # The name for this set of Sphinx documents.
 120 # "<project> v<release> documentation" by default.
 121 # html_title = 'OpenDaylight Documentation v0.3.0'
 122
 123 # A shorter title for the navigation bar.  Default is the same as html_title.
 124 # html_short_title = None
 125
 126 # The name of an image file (relative to this directory) to place at the top
 127 # of the sidebar.
 128 html_logo = '_static/opnfv-logo.png'
 129
 130 # The name of an image file (relative to this directory) to use as a favicon of
 131 # the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 132 # pixels large.
 133 html_favicon = '_static/favicon.ico'
 134
 135 # Add any paths that contain custom static files (such as style sheets) here,
 136 # relative to this directory. They are copied after the builtin static files,
 137 # so a file named "default.css" will overwrite the builtin "default.css".
 138 html_static_path = ['_static']
 139
 140 # Add any extra paths that contain custom files (such as robots.txt or
 141 # .htaccess) here, relative to this directory. These files are copied
 142 # directly to the root of the documentation.
 143 # html_extra_path = []
 144
 145 # If not None, a 'Last updated on:' timestamp is inserted at every page
 146 # bottom, using the given strftime format.
 147 # The empty string is equivalent to '%b %d, %Y'.
 148 # html_last_updated_fmt = None
 149
 150 # If true, SmartyPants will be used to convert quotes and dashes to
 151 # typographically correct entities.
 152 # html_use_smartypants = True
 153
 154 # Custom sidebar templates, maps document names to template names.
 155 # html_sidebars = {}
 156
 157 # Additional templates that should be rendered to pages, maps page names to
 158 # template names.
 159 # html_additional_pages = {}
 160
 161 # If false, no module index is generated.
 162 # html_domain_indices = True
 163
 164 # If false, no index is generated.
 165 # html_use_index = True
 166
 167 # If true, the index is split into individual pages for each letter.
 168 # html_split_index = False
 169
 170 # If true, links to the reST sources are added to the pages.
 171 # html_show_sourcelink = True
 172
 173 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 174 # html_show_sphinx = True
 175
 176 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
 177 # html_show_copyright = True
 178
 179 # If true, an OpenSearch description file will be output, and all pages will
 180 # contain a <link> tag referring to it.  The value of this option must be the
 181 # base URL from which the finished HTML is served.
 182 # html_use_opensearch = ''
 183
 184 # This is the file name suffix for HTML files (e.g. ".xhtml").
 185 # html_file_suffix = None
 186
 187 # Language to be used for generating the HTML full-text search index.
 188 # Sphinx supports the following languages:
 189 #   'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
 190 #   'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
 191 # html_search_language = 'en'
 192
 193 # A dictionary with options for the search language support, empty by default.
 194 # 'ja' uses this config value.
 195 # 'zh' user can custom change `jieba` dictionary path.
 196 # html_search_options = {'type': 'default'}
 197
 198 # The name of a javascript file (relative to the configuration directory) that
 199 # implements a search results scorer. If empty, the default will be used.
 200 # html_search_scorer = 'scorer.js'
 201
 202 # Output file base name for HTML help builder.
 203 htmlhelp_basename = 'OPNFV'
 204
 205 # -- Options for LaTeX output ---------------------------------------------
 206
 207 latex_elements = {
 208     # The paper size ('letterpaper' or 'a4paper').
 209     #'papersize': 'letterpaper',
 210
 211     # The font size ('10pt', '11pt' or '12pt').
 212     #'pointsize': '10pt',
 213
 214     # Additional stuff for the LaTeX preamble.
 215     #'preamble': '',
 216
 217     # Latex figure (float) alignment
 218     #'figure_align': 'htbp',
 219 }
 220
 221 # Grouping the document tree into LaTeX files. List of tuples
 222 # (source start file, target name, title,
 223 #  author, documentclass [howto, manual, or own class]).
 224 latex_documents = [
 225     (master_doc, 'OPNFV.tex', 'OPNFV Documentation',
 226      'OPNFV Project', 'manual'),
 227 ]
 228
 229 # The name of an image file (relative to this directory) to place at the top of
 230 # the title page.
 231 # latex_logo = None
 232
 233 # For "manual" documents, if this is true, then toplevel headings are parts,
 234 # not chapters.
 235 # latex_use_parts = False
 236
 237 # If true, show page references after internal links.
 238 # latex_show_pagerefs = False
 239
 240 # If true, show URL addresses after external links.
 241 # latex_show_urls = False
 242
 243 # Documents to append as an appendix to all manuals.
 244 # latex_appendices = []
 245
 246 # If false, no module index is generated.
 247 # latex_domain_indices = True
 248
 249
 250 # -- Options for manual page output ---------------------------------------
 251
 252 # One entry per manual page. List of tuples
 253 # (source start file, name, description, authors, manual section).
 254 man_pages = [
 255     (master_doc, 'OPNFVDocs', 'OPNFV Documentation',
 256      [author], 1)
 257 ]
 258
 259 # If true, show URL addresses after external links.
 260 # man_show_urls = False
 261
 262
 263 # -- Options for Texinfo output -------------------------------------------
 264
 265 # Grouping the document tree into Texinfo files. List of tuples
 266 # (source start file, target name, title, author,
 267 #  dir menu entry, description, category)
 268 texinfo_documents = [
 269     (master_doc, 'OPNFVDocs', 'OPNFV Documentation',
 270      author, 'OPNFV', 'One line description of project.',
 271      'Miscellaneous'),
 272 ]
 273
 274 html_sidebars = {'**': ['localtoc.html', 'relations.html'],}
 275 # Documents to append as an appendix to all manuals.
 276 # texinfo_appendices = []
 277
 278 # If false, no module index is generated.
 279 # texinfo_domain_indices = True
 280
 281 # How to display URL addresses: 'footnote', 'no', or 'inline'.
 282 # texinfo_show_urls = 'footnote'
 283
 284 # If true, do not generate a @detailmenu in the "Top" node's menu.
 285 # texinfo_no_detailmenu = False
 286
 287 intersphinx_mapping = {}
 288 intersphinx_mapping['airship'] = ('https://opnfv-airship.readthedocs.io/en/%s' % branch, None)
 289 intersphinx_mapping['apex'] = ('https://opnfv-apex.readthedocs.io/en/%s' % branch, None)
 290 intersphinx_mapping['armband'] = ('https://opnfv-armband.readthedocs.io/en/%s' % branch, None)
 291 intersphinx_mapping['auto'] = ('https://opnfv-auto.readthedocs.io/en/%s' % branch, None)
 292 intersphinx_mapping['availability'] = ('https://opnfv-availability.readthedocs.io/en/%s' % branch, None)
 293 intersphinx_mapping['barometer'] = ('https://opnfv-barometer.readthedocs.io/en/%s' % branch, None)
 294 intersphinx_mapping['bottlenecks'] = ('https://opnfv-bottlenecks.readthedocs.io/en/%s' % branch, None)
 295 intersphinx_mapping['calipso'] = ('https://opnfv-calipso.readthedocs.io/en/%s' % branch, None)
 296 intersphinx_mapping['clover'] = ('https://opnfv-clover.readthedocs.io/en/%s' % branch, None)
 297 intersphinx_mapping['compass4nfv'] = ('https://opnfv-compass4nfv.readthedocs.io/en/%s' % branch, None)
 298 intersphinx_mapping['container4nfv'] = ('https://opnfv-container4nfv.readthedocs.io/en/%s' % branch, None)
 299 # intersphinx_mapping['copper'] = ('https://opnfv-copper.readthedocs.io/en/%s' % branch, None)
 300 intersphinx_mapping['daisy'] = ('https://opnfv-daisy.readthedocs.io/en/%s' % branch, None)
 301 intersphinx_mapping['doctor'] = ('https://opnfv-doctor.readthedocs.io/en/%s' % branch, None)
 302 intersphinx_mapping['dovetail'] = ('https://opnfv-dovetail.readthedocs.io/en/%s' % branch, None)
 303 intersphinx_mapping['edgecloud'] = ('https://opnfv-edgecloud.readthedocs.io/en/%s' % branch, None)
 304 # intersphinx_mapping['fds'] = ('https://opnfv-fds.readthedocs.io/en/%s' % branch, None)
 305 intersphinx_mapping['fuel'] = ('https://opnfv-fuel.readthedocs.io/en/%s' % branch, None)
 306 intersphinx_mapping['functest'] = ('https://opnfv-functest.readthedocs.io/en/%s' % branch, None)
 307 intersphinx_mapping['ipv6'] = ('https://opnfv-ipv6.readthedocs.io/en/%s' % branch, None)
 308 # intersphinx_mapping['moon'] = ('https://opnfv-moon.readthedocs.io/en/%s' % branch, None)
 309 # intersphinx_mapping['netready'] = ('https://opnfv-netready.readthedocs.io/en/%s' % branch, None)
 310 intersphinx_mapping['nfvbench'] = ('https://opnfv-nfvbench.readthedocs.io/en/%s' % branch, None)
 311 intersphinx_mapping['onosfw'] = ('https://opnfv-onosfw.readthedocs.io/en/%s' % branch, None)
 312 intersphinx_mapping['orchestra'] = ('https://opnfv-orchestra.readthedocs.io/en/%s' % branch, None)
 313 intersphinx_mapping['ovn4nfv'] = ('https://opnfv-ovn4nfv.readthedocs.io/en/%s' % branch, None)
 314 intersphinx_mapping['ovno'] = ('https://opnfv-ovno.readthedocs.io/en/%s' % branch, None)
 315 intersphinx_mapping['parser'] = ('https://opnfv-parser.readthedocs.io/en/%s' % branch, None)
 316 intersphinx_mapping['pharos'] = ('https://opnfv-pharos.readthedocs.io/en/%s' % branch, None)
 317 intersphinx_mapping['promise'] = ('https://opnfv-promise.readthedocs.io/en/%s' % branch, None)
 318 intersphinx_mapping['qtip'] = ('https://opnfv-qtip.readthedocs.io/en/%s' % branch, None)
 319 intersphinx_mapping['releng'] = ('https://opnfv-releng.readthedocs.io/en/latest', None)
 320 intersphinx_mapping['releng-xci'] = ('https://opnfv-releng-xci.readthedocs.io/en/%s' % branch, None)
 321 intersphinx_mapping['samplevnf'] = ('https://opnfv-samplevnf.readthedocs.io/en/%s' % branch, None)
 322 intersphinx_mapping['sdnvpn'] = ('https://opnfv-sdnvpn.readthedocs.io/en/%s' % branch, None)
 323 intersphinx_mapping['sfc'] = ('https://opnfv-sfc.readthedocs.io/en/%s' % branch, None)
 324 intersphinx_mapping['snaps'] = ('https://opnfv-snaps.readthedocs.io/en/%s' % branch, None)
 325 intersphinx_mapping['stor4nfv'] = ('https://opnfv-stor4nfv.readthedocs.io/en/%s' % branch, None)
 326 intersphinx_mapping['storperf'] = ('https://opnfv-storperf.readthedocs.io/en/%s' % branch, None)
 327 intersphinx_mapping['vswitchperf'] = ('https://opnfv-vswitchperf.readthedocs.io/en/%s' % branch, None)
 328 intersphinx_mapping['yardstick'] = ('https://opnfv-yardstick.readthedocs.io/en/%s' % branch, None)