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