resources/tools/presentation/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # CSIT report documentation build configuration file
   4 #
   5 # This file is execfile()d with the current directory set to its
   6 # containing dir.
   7 #
   8 # Note that not all possible configuration values are present in this
   9 # autogenerated file.
  10 #
  11 # All configuration values have a default; values that are commented out
  12 # serve to show the default.
  13
  14 # If extensions (or modules to document with autodoc) are in another directory,
  15 # add these directories to sys.path here. If the directory is relative to the
  16 # documentation root, use os.path.abspath to make it absolute, like shown here.
  17 #
  18 import os
  19 import sys
  20
  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 = ['sphinxcontrib.programoutput',
  33               'sphinx.ext.ifconfig']
  34
  35 # Add any paths that contain templates here, relative to this directory.
  36 templates_path = ['_templates']
  37
  38 # The suffix(es) of source filenames.
  39 # You can specify multiple suffix as a list of string:
  40 #
  41 source_suffix = ['.rst', '.md']
  42
  43 # The master toctree document.
  44 master_doc = 'index'
  45
  46 # General information about the project.
  47 project = u'FD.io CSIT'
  48 copyright = u'2018, FD.io'
  49 author = u'FD.io CSIT'
  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''
  57 # The full version, including alpha/beta/rc tags.
  58 #release = u''
  59
  60 rst_epilog = """
  61 .. |release-1| replace:: rls1710
  62 .. |srelease| replace:: {srelease}
  63 .. |vpp-release| replace:: VPP-{vpprelease} release
  64 .. |vpp-release-1| replace:: VPP-17.10 release
  65 .. |dpdk-release| replace:: DPDK {dpdkrelease}
  66 .. |trex-release| replace:: TRex v2.35
  67 .. |virl-image-ubuntu| replace:: ubuntu-16.04.1_2017-10-21_2.0
  68 .. |virl-image-centos| replace:: centos-7.3-1611_2017-02-23_1.4
  69
  70 .. _pdf version of this report: https://docs.fd.io/csit/{release}/report/_static/archive/csit_{release}.pdf
  71 .. _tag documentation rst file: https://git.fd.io/csit/tree/docs/tag_documentation.rst?h={release}
  72 .. _TRex intallation: https://git.fd.io/csit/tree/resources/tools/trex/trex_installer.sh?h={release}
  73 .. _TRex driver: https://git.fd.io/csit/tree/resources/tools/trex/trex_stateless_profile.py?h={release}
  74 .. _VIRL topologies directory: https://git.fd.io/csit/tree/resources/tools/virl/topologies/?h={release}
  75 .. _VIRL images lists: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/ubuntu/lists/?h={release}
  76 .. _VIRL nested: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/nested/?h={release}
  77 .. _CSIT Honeycomb Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.func.honeycomb.html
  78 .. _CSIT Honeycomb Performance Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.perf.honeycomb.html
  79 .. _CSIT DPDK Performance Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.dpdk.perf.html
  80 .. _CSIT VPP Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.func.html
  81 .. _CSIT VPP Performance Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.perf.html
  82 .. _CSIT NSH_SFC Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.nsh_sfc.func.html
  83 .. _VPP test framework documentation: https://docs.fd.io/vpp/{vpprelease}/vpp_make_test/html/
  84 .. _FD.io test executor vpp performance jobs: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-{srelease}-all
  85 .. _FD.io test executor ligato performance jobs: https://jenkins.fd.io/job/csit-ligato-perf-{srelease}-all
  86 .. _FD.io test executor vpp functional jobs: https://jenkins.fd.io/view/csit/job/csit-vpp-functional-{srelease}-ubuntu1604-virl/lastSuccessfulBuild
  87 .. _FD.io test executor dpdk performance jobs: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-{srelease}-all
  88 .. _FD.io test executor Honeycomb functional jobs: https://jenkins.fd.io/view/csit/job/hc2vpp-csit-integration-{srelease}-ubuntu1604/lastSuccessfulBuild
  89 .. _FD.io test executor honeycomb performance jobs: https://jenkins.fd.io/view/hc2vpp/job/hc2vpp-csit-perf-master-ubuntu1604/lastSuccessfulBuild
  90 .. _FD.io test executor NSH_SFC functional jobs: https://jenkins.fd.io/view/csit/job/csit-nsh_sfc-verify-func-{srelease}-ubuntu1604-virl/lastSuccessfulBuild
  91 .. _FD.io VPP compile job: https://jenkins.fd.io/view/vpp/job/vpp-merge-{srelease}-ubuntu1604/
  92 .. _FD.io DPDK compile job: https://jenkins.fd.io/view/deb-dpdk/job/deb_dpdk-merge-{sdpdkrelease}-ubuntu1604/
  93 .. _CSIT Testbed Setup: https://git.fd.io/csit/tree/resources/tools/testbed-setup/README.md?h={release}
  94 """.format(release='rls1801', srelease='1801', vpprelease='18.01', dpdkrelease='17.11', sdpdkrelease='1711')
  95
  96 # The language for content autogenerated by Sphinx. Refer to documentation
  97 # for a list of supported languages.
  98 #
  99 # This is also used if you do content translation via gettext catalogs.
 100 # Usually you set "language" from the command line for these cases.
 101 language = 'en'
 102
 103 # List of patterns, relative to source directory, that match files and
 104 # directories to ignore when looking for source files.
 105 # This patterns also effect to html_static_path and html_extra_path
 106 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 107
 108 # The name of the Pygments (syntax highlighting) style to use.
 109 pygments_style = 'sphinx'
 110
 111 # If true, `todo` and `todoList` produce output, else they produce nothing.
 112 todo_include_todos = False
 113
 114 # -- Options for HTML output ----------------------------------------------
 115
 116 # The theme to use for HTML and HTML Help pages.  See the documentation for
 117 # a list of builtin themes.
 118 #
 119 html_theme = 'sphinx_rtd_theme'
 120
 121 # Theme options are theme-specific and customize the look and feel of a theme
 122 # further.  For a list of options available for each theme, see the
 123 # documentation.
 124 #
 125 # html_theme_options = {}
 126
 127 # Add any paths that contain custom static files (such as style sheets) here,
 128 # relative to this directory. They are copied after the builtin static files,
 129 # so a file named "default.css" will overwrite the builtin "default.css".
 130 html_theme_path = ['env/lib/python2.7/site-packages/sphinx_rtd_theme']
 131
 132 # html_static_path = ['_build/_static']
 133 html_static_path = ['_tmp/src/_static']
 134
 135 html_context = {
 136     'css_files': [
 137         '_static/theme_overrides.css',  # overrides for wide tables in RTD theme
 138         ],
 139     }
 140
 141 # -- Options for LaTeX output ---------------------------------------------
 142
 143 latex_engine = 'pdflatex'
 144
 145 latex_elements = {
 146      # The paper size ('letterpaper' or 'a4paper').
 147      #
 148      'papersize': 'a4paper',
 149
 150      # The font size ('10pt', '11pt' or '12pt').
 151      #
 152      #'pointsize': '10pt',
 153
 154      # Additional stuff for the LaTeX preamble.
 155      #
 156      'preamble': r'''
 157          \usepackage{pdfpages}
 158          \usepackage{svg}
 159          \usepackage{charter}
 160          \usepackage[defaultsans]{lato}
 161          \usepackage{inconsolata}
 162          \usepackage{csvsimple}
 163          \usepackage{longtable}
 164          \usepackage{booktabs}
 165      ''',
 166
 167      # Latex figure (float) alignment
 168      #
 169      'figure_align': 'H',
 170
 171      # Latex font setup
 172      #
 173      'fontpkg': r'''
 174          \renewcommand{\familydefault}{\sfdefault}
 175      ''',
 176
 177      # Latex other setup
 178      #
 179      'extraclassoptions': 'openany',
 180      'sphinxsetup': r'''
 181          TitleColor={RGB}{225,38,40},
 182          InnerLinkColor={RGB}{62,62,63},
 183          OuterLinkColor={RGB}{225,38,40},
 184          shadowsep=0pt,
 185          shadowsize=0pt,
 186          shadowrule=0pt
 187      '''
 188 }
 189
 190 # Grouping the document tree into LaTeX files. List of tuples
 191 # (source start file, target name, title,
 192 #  author, documentclass [howto, manual, or own class]).
 193 latex_documents = [
 194     (master_doc, 'csit.tex', u'CSIT REPORT',
 195      u'', 'manual'),
 196 ]
 197
 198 # The name of an image file (relative to this directory) to place at the top of
 199 # the title page.
 200 #
 201 # latex_logo = 'fdio.pdf'
 202
 203 # For "manual" documents, if this is true, then toplevel headings are parts,
 204 # not chapters.
 205 #
 206 # latex_use_parts = True
 207
 208 # If true, show page references after internal links.
 209 #
 210 latex_show_pagerefs = True
 211
 212 # If true, show URL addresses after external links.
 213 #
 214 latex_show_urls = 'footnote'
 215
 216 # Documents to append as an appendix to all manuals.
 217 #
 218 # latex_appendices = []
 219
 220 # It false, will not define \strong, \code,     itleref, \crossref ... but only
 221 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
 222 # packages.
 223 #
 224 # latex_keep_old_macro_names = True
 225
 226 # If false, no module index is generated.
 227 #
 228 # latex_domain_indices = True