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