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