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