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