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