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