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