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