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