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