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
  19 import os
  20 import sys
  21
  22 sys.path.insert(0, os.path.abspath('.'))
  23
  24 # -- General configuration ------------------------------------------------
  25
  26 # If your documentation needs a minimal Sphinx version, state it here.
  27 #
  28 # needs_sphinx = '1.0'
  29
  30 # Add any Sphinx extension module names here, as strings. They can be
  31 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  32 # ones.
  33 extensions = ['sphinxcontrib.programoutput',
  34               'sphinx.ext.ifconfig']
  35
  36 # Add any paths that contain templates here, relative to this directory.
  37 templates_path = ['_templates']
  38
  39 # The suffix(es) of source file names.
  40 # You can specify multiple suffix as a list of string:
  41 #
  42 source_suffix = ['.rst', '.md']
  43
  44 # The master toctree document.
  45 master_doc = 'index'
  46
  47 # General information about the project.
  48 project = u'FD.io CSIT-1810.03'
  49 copyright = u'2019, FD.io'
  50 author = u'FD.io CSIT'
  51
  52 # The version info for the project you're documenting, acts as replacement for
  53 # |version| and |release|, also used in various other places throughout the
  54 # built documents.
  55 #
  56 # The short X.Y version.
  57 # version = u''
  58 # The full version, including alpha/beta/rc tags.
  59 # release = u''
  60
  61 rst_epilog = """
  62 .. |release-1| replace:: {prev_release}
  63 .. |srelease| replace:: {srelease}
  64 .. |csit-release| replace:: CSIT-{csitrelease}
  65 .. |csit-release-1| replace:: CSIT-{csit_prev_release}
  66 .. |vpp-release| replace:: VPP-{vpprelease} release
  67 .. |vpp-release-1| replace:: VPP-{vpp_prev_release} release
  68 .. |dpdk-release| replace:: DPDK {dpdkrelease}
  69 .. |trex-release| replace:: TRex {trex_version}
  70 .. |virl-image-ubuntu| replace:: {csit_ubuntu_ver}
  71 .. |virl-image-centos| replace:: {csit_centos_ver}
  72
  73 .. _pdf version of this report: https://docs.fd.io/csit/{release}/report/_static/archive/csit_{release}.{report_week}.pdf
  74 .. _tag documentation rst file: https://git.fd.io/csit/tree/docs/tag_documentation.rst?h={release}
  75 .. _TRex intallation: https://git.fd.io/csit/tree/resources/tools/trex/trex_installer.sh?h={release}
  76 .. _TRex driver: https://git.fd.io/csit/tree/resources/tools/trex/trex_stateless_profile.py?h={release}
  77 .. _VIRL topologies directory: https://git.fd.io/csit/tree/resources/tools/virl/topologies/?h={release}
  78 .. _VIRL ubuntu images lists: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/ubuntu/lists/?h={release}
  79 .. _VIRL centos images lists: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/centos/lists/?h={release}
  80 .. _VIRL nested: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/nested/?h={release}
  81 .. _CSIT Honeycomb Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.func.honeycomb.html
  82 .. _CSIT Honeycomb Performance Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.perf.honeycomb.html
  83 .. _CSIT DPDK Performance Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.dpdk.perf.html
  84 .. _CSIT VPP Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.func.html
  85 .. _CSIT VPP Performance Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.perf.html
  86 .. _CSIT NSH_SFC Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.nsh_sfc.func.html
  87 .. _CSIT DMM Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.dmm.func.html
  88 .. _CSIT VPP Device Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.device.html
  89 .. _VPP test framework documentation: https://docs.fd.io/vpp/{vpprelease}/vpp_make_test/html/
  90 .. _FD.io test executor dpdk performance job 3n-hsw: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-verify-{srelease}-3n-hsw
  91 .. _FD.io test executor dpdk performance job 3n-skx: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-verify-{srelease}-3n-skx
  92 .. _FD.io test executor dpdk performance job 2n-skx: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-verify-{srelease}-2n-skx
  93 .. _FD.io test executor vpp performance job 3n-hsw: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-{srelease}-3n-hsw
  94 .. _FD.io test executor vpp performance job 3n-skx: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-{srelease}-3n-skx
  95 .. _FD.io test executor vpp performance job 2n-skx: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-{srelease}-2n-skx
  96 .. _FD.io test executor ligato performance jobs: https://jenkins.fd.io/job/csit-ligato-perf-{srelease}-all
  97 .. _FD.io test executor vpp functional jobs using Ubuntu: https://jenkins.fd.io/view/csit/job/csit-vpp-functional-{srelease}-ubuntu1604-virl
  98 .. _FD.io test executor vpp functional jobs using CentOs: https://jenkins.fd.io/view/csit/job/csit-vpp-functional-{srelease}-centos7-virl
  99 .. _FD.io test executor vpp device jobs using Ubuntu: https://jenkins.fd.io/view/csit/job/csit-vpp-device-{srelease}-ubuntu1804-1n-skx
 100 .. _FD.io test executor Honeycomb functional jobs: https://jenkins.fd.io/view/csit/job/hc2vpp-csit-integration-{srelease}-ubuntu1604
 101 .. _FD.io test executor NSH_SFC functional jobs: https://jenkins.fd.io/view/csit/job/csit-nsh_sfc-verify-func-{srelease}-ubuntu1604-virl
 102 .. _FD.io test executor DMM functional jobs: https://jenkins.fd.io/view/csit/job/csit-dmm-functional-{srelease}-ubuntu1604-virl
 103 .. _FD.io VPP compile job: https://jenkins.fd.io/view/vpp/job/vpp-merge-{srelease}-ubuntu1604/
 104 .. _FD.io DPDK compile job: https://jenkins.fd.io/view/deb-dpdk/job/deb_dpdk-merge-{sdpdkrelease}-ubuntu1604/
 105 .. _CSIT Testbed Setup: https://git.fd.io/csit/tree/resources/tools/testbed-setup/README.md?h={release}
 106 .. _K8s configuration files: https://github.com/FDio/csit/tree/{release}/resources/templates/kubernetes
 107 """.format(release='rls1810',
 108            report_week='03',
 109            prev_release='rls1807',
 110            srelease='1810',
 111            csitrelease='1810',
 112            csit_prev_release='1807',
 113            vpprelease='18.10',
 114            vpp_prev_release='18.07',
 115            dpdkrelease='18.08',
 116            sdpdkrelease='1808',
 117            trex_version='v2.35',
 118            csit_ubuntu_ver='csit-ubuntu-16.04.1_2018-03-07_2.1',
 119            csit_centos_ver='csit-centos-7.4-1711_2018-03-20_1.9')
 120
 121 # The language for content autogenerated by Sphinx. Refer to documentation
 122 # for a list of supported languages.
 123 #
 124 # This is also used if you do content translation via gettext catalogs.
 125 # Usually you set "language" from the command line for these cases.
 126 language = 'en'
 127
 128 # List of patterns, relative to source directory, that match files and
 129 # directories to ignore when looking for source files.
 130 # This patterns also effect to html_static_path and html_extra_path
 131 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 132
 133 # The name of the Pygments (syntax highlighting) style to use.
 134 pygments_style = 'sphinx'
 135
 136 # If true, `todo` and `todoList` produce output, else they produce nothing.
 137 todo_include_todos = False
 138
 139 # -- Options for HTML output ----------------------------------------------
 140
 141 # The theme to use for HTML and HTML Help pages.  See the documentation for
 142 # a list of builtin themes.
 143 #
 144 html_theme = 'sphinx_rtd_theme'
 145
 146 # Theme options are theme-specific and customize the look and feel of a theme
 147 # further.  For a list of options available for each theme, see the
 148 # documentation.
 149 #
 150 html_theme_options = {
 151     'canonical_url': '',
 152     'analytics_id': '',
 153     'logo_only': False,
 154     'display_version': True,
 155     'prev_next_buttons_location': 'bottom',
 156     'style_external_links': False,
 157     # Toc options
 158     'collapse_navigation': True,
 159     'sticky_navigation': True,
 160     'navigation_depth': 3,
 161     'includehidden': True,
 162     'titles_only': False
 163 }
 164
 165 # Add any paths that contain custom static files (such as style sheets) here,
 166 # relative to this directory. They are copied after the builtin static files,
 167 # so a file named "default.css" will overwrite the builtin "default.css".
 168 html_theme_path = ['env/lib/python2.7/site-packages/sphinx_rtd_theme']
 169
 170 # html_static_path = ['_build/_static']
 171 html_static_path = ['_tmp/src/_static']
 172
 173 html_context = {
 174     'css_files': [
 175         '_static/theme_overrides.css',  # overrides for wide tables in RTD theme
 176         ],
 177     }
 178
 179 # If false, no module index is generated.
 180 html_domain_indices = True
 181
 182 # If false, no index is generated.
 183 html_use_index = True
 184
 185 # If true, the index is split into individual pages for each letter.
 186 html_split_index = False
 187
 188 # -- Options for LaTeX output ---------------------------------------------
 189
 190 latex_engine = 'pdflatex'
 191
 192 latex_elements = {
 193      # The paper size ('letterpaper' or 'a4paper').
 194      #
 195      'papersize': 'a4paper',
 196
 197      # The font size ('10pt', '11pt' or '12pt').
 198      #
 199      #'pointsize': '10pt',
 200
 201      # Additional stuff for the LaTeX preamble.
 202      #
 203      'preamble': r'''
 204          \usepackage{pdfpages}
 205          \usepackage{svg}
 206          \usepackage{charter}
 207          \usepackage[defaultsans]{lato}
 208          \usepackage{inconsolata}
 209          \usepackage{csvsimple}
 210          \usepackage{longtable}
 211          \usepackage{booktabs}
 212      ''',
 213
 214      # Latex figure (float) alignment
 215      #
 216      'figure_align': 'H',
 217
 218      # Latex font setup
 219      #
 220      'fontpkg': r'''
 221          \renewcommand{\familydefault}{\sfdefault}
 222      ''',
 223
 224      # Latex other setup
 225      #
 226      'extraclassoptions': 'openany',
 227      'sphinxsetup': r'''
 228          TitleColor={RGB}{225,38,40},
 229          InnerLinkColor={RGB}{62,62,63},
 230          OuterLinkColor={RGB}{225,38,40},
 231          shadowsep=0pt,
 232          shadowsize=0pt,
 233          shadowrule=0pt
 234      '''
 235 }
 236
 237 # Grouping the document tree into LaTeX files. List of tuples
 238 # (source start file, target name, title,
 239 #  author, documentclass [howto, manual, or own class]).
 240 latex_documents = [
 241     (master_doc, 'csit.tex', u'CSIT REPORT',
 242      u'', 'manual'),
 243 ]
 244
 245 # The name of an image file (relative to this directory) to place at the top of
 246 # the title page.
 247 #
 248 # latex_logo = 'fdio.pdf'
 249
 250 # For "manual" documents, if this is true, then toplevel headings are parts,
 251 # not chapters.
 252 #
 253 # latex_use_parts = True
 254
 255 # If true, show page references after internal links.
 256 #
 257 latex_show_pagerefs = True
 258
 259 # If true, show URL addresses after external links.
 260 #
 261 latex_show_urls = 'footnote'
 262
 263 # Documents to append as an appendix to all manuals.
 264 #
 265 # latex_appendices = []
 266
 267 # It false, will not define \strong, \code,     itleref, \crossref ... but only
 268 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
 269 # packages.
 270 #
 271 # latex_keep_old_macro_names = True
 272
 273 # If false, no module index is generated.
 274 #
 275 # latex_domain_indices = True