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 = '45'
  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 - Atom Snowridge: https://git.fd.io/csit/tree/docs/lab/testbeds_sm_snr_hw_bios_cfg.md?h={release}
  84 .. _FD.io CSIT testbeds - Atom Denverton: https://git.fd.io/csit/tree/docs/lab/testbeds_sm_dnv_hw_bios_cfg.md?h={release}
  85 .. _FD.io CSIT testbeds - EPYC Zen2: https://git.fd.io/csit/tree/docs/lab/testbeds_sm_zn2_hw_bios_cfg.md?h={release}
  86 .. _FD.io CSIT testbeds - Xeon Ice Lake: https://git.fd.io/csit/tree/docs/lab/testbeds_sm_icx_hw_bios_cfg.md?h={release}
  87 .. _FD.io CSIT testbeds - Xeon Cascade Lake: https://git.fd.io/csit/tree/docs/lab/testbeds_sm_clx_hw_bios_cfg.md?h={release}
  88 .. _Ansible inventory - hosts: https://git.fd.io/csit/tree/fdio.infra.ansible/inventories/lf_inventory/host_vars?h={release}
  89 .. _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
  90 .. _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
  91 .. _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
  92 .. _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
  93 .. _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
  94 .. _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
  95 .. _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
  96 .. _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
  97 .. _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
  98 .. _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
  99 .. _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
 100 .. _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
 101 .. _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
 102 .. _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
 103 .. _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
 104 .. _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
 105 .. _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
 106 .. _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
 107 .. _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
 108 .. _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
 109 .. _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
 110 .. _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
 111 .. _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
 112 .. _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
 113 .. _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
 114 .. _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
 115 .. _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
 116 .. _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
 117 .. _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
 118 .. _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
 119 .. _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
 120 .. _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
 121 .. _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
 122 .. _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
 123 .. _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
 124 .. _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
 125 .. _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
 126 .. _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
 127 .. _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
 128 .. _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
 129 .. _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
 130 .. _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
 131 .. _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
 132 .. _FD.io VPP compile job: https://jenkins.fd.io/view/vpp/job/vpp-merge-{srelease}-ubuntu2004-x86_64/
 133 .. _CSIT Testbed Setup: https://git.fd.io/csit/tree/fdio.infra.ansible?h={release}
 134 .. _VPP startup.conf: https://git.fd.io/vpp/tree/src/vpp/conf/startup.conf?h=stable/{srelease}&id={vpp_release_commit_id}
 135 """.format(release='rls2210',
 136            report_week=report_week,
 137            prev_release='rls2206',
 138            srelease='2210',
 139            csitrelease='2210',
 140            csit_prev_release='2206',
 141            vpprelease='22.10',
 142            vpp_prev_release='22.06',
 143            dpdkrelease='22.07',
 144            dpdk_prev_release='22.03',
 145            sdpdkrelease='22.07',
 146            trex_version='v3.00',
 147            vpp_release_commit_id='0d352a97c5e3ad1f5f6eab18a978a14b0b9e06a8')
 148
 149 # The language for content autogenerated by Sphinx. Refer to documentation
 150 # for a list of supported languages.
 151 #
 152 # This is also used if you do content translation via gettext catalogs.
 153 # Usually you set "language" from the command line for these cases.
 154 language = 'en'
 155
 156 # List of patterns, relative to source directory, that match files and
 157 # directories to ignore when looking for source files.
 158 # This patterns also effect to html_static_path and html_extra_path
 159 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 160
 161 # The name of the Pygments (syntax highlighting) style to use.
 162 pygments_style = 'sphinx'
 163
 164 # If true, `todo` and `todoList` produce output, else they produce nothing.
 165 todo_include_todos = False
 166
 167 # -- Options for HTML output ----------------------------------------------
 168
 169 # The theme to use for HTML and HTML Help pages.  See the documentation for
 170 # a list of builtin themes.
 171 #
 172 html_theme = 'sphinx_rtd_theme'
 173
 174 # Theme options are theme-specific and customize the look and feel of a theme
 175 # further.  For a list of options available for each theme, see the
 176 # documentation.
 177 #
 178 html_theme_options = {
 179     'analytics_id': '',
 180     'analytics_anonymize_ip': False,
 181     'logo_only': False,
 182     'display_version': True,
 183     'prev_next_buttons_location': 'bottom',
 184     'style_external_links': False,
 185     'vcs_pageview_mode': '',
 186     'style_nav_header_background': '#2980b9',
 187     # Toc options
 188     'collapse_navigation': True,
 189     'sticky_navigation': True,
 190     'navigation_depth': 4,
 191     'includehidden': True,
 192     'titles_only': False
 193 }
 194
 195 # Add any paths that contain custom static files (such as style sheets) here,
 196 # relative to this directory. They are copied after the builtin static files,
 197 # so a file named "default.css" will overwrite the builtin "default.css".
 198
 199 html_static_path = ['_tmp/src/_static']
 200
 201 html_context = {
 202     'css_files': [
 203         '_static/css/theme.css',
 204         '_static/css/badge_only.css',
 205         # overrides for wide tables in RTD theme
 206         '_static/theme_overrides.css',
 207     ]
 208 }
 209
 210 # If false, no module index is generated.
 211 html_domain_indices = True
 212
 213 # If false, no index is generated.
 214 html_use_index = True
 215
 216 # If true, the index is split into individual pages for each letter.
 217 html_split_index = False
 218
 219 # -- Options for LaTeX output ---------------------------------------------
 220
 221 latex_engine = 'pdflatex'
 222
 223 latex_elements = {
 224     # The paper size ('letterpaper' or 'a4paper').
 225     #
 226     'papersize': 'a4paper',
 227
 228     # The font size ('10pt', '11pt' or '12pt').
 229     #
 230     #'pointsize': '10pt',
 231
 232     # Additional stuff for the LaTeX preamble.
 233     #
 234     'preamble': r'''
 235      \usepackage{pdfpages}
 236      \usepackage{svg}
 237      \usepackage{charter}
 238      \usepackage[defaultsans]{lato}
 239      \usepackage{inconsolata}
 240      \usepackage{csvsimple}
 241      \usepackage{longtable}
 242      \usepackage{booktabs}
 243     ''',
 244
 245     # Latex figure (float) alignment
 246     #
 247     'figure_align': 'H',
 248
 249     # Latex font setup
 250     #
 251     'fontpkg': r'''
 252      \renewcommand{\familydefault}{\sfdefault}
 253     ''',
 254
 255     # Latex other setup
 256     #
 257     'extraclassoptions': 'openany',
 258     'sphinxsetup': r'''
 259      TitleColor={RGB}{225,38,40},
 260      InnerLinkColor={RGB}{62,62,63},
 261      OuterLinkColor={RGB}{225,38,40},
 262      shadowsep=0pt,
 263      shadowsize=0pt,
 264      shadowrule=0pt
 265     '''
 266 }
 267
 268 # Grouping the document tree into LaTeX files. List of tuples
 269 # (source start file, target name, title,
 270 #  author, documentclass [howto, manual, or own class]).
 271 latex_documents = [
 272     (master_doc, 'csit.tex', 'CSIT REPORT', '', 'manual'),
 273 ]
 274
 275 # The name of an image file (relative to this directory) to place at the top of
 276 # the title page.
 277 #
 278 # latex_logo = 'fdio.pdf'
 279
 280 # For "manual" documents, if this is true, then toplevel headings are parts,
 281 # not chapters.
 282 #
 283 # latex_use_parts = True
 284
 285 # If true, show page references after internal links.
 286 #
 287 latex_show_pagerefs = True
 288
 289 # If true, show URL addresses after external links.
 290 #
 291 latex_show_urls = 'footnote'
 292
 293 # Documents to append as an appendix to all manuals.
 294 #
 295 # latex_appendices = []
 296
 297 # It false, will not define \strong, \code,     itleref, \crossref ... but only
 298 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
 299 # packages.
 300 #
 301 # latex_keep_old_macro_names = True
 302
 303 # If false, no module index is generated.
 304 #
 305 # latex_domain_indices = True