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