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