diff options
Diffstat (limited to 'resources/tools/presentation/conf.py')
| -rw-r--r-- | resources/tools/presentation/conf.py | 237 |
1 files changed, 111 insertions, 126 deletions
diff --git a/resources/tools/presentation/conf.py b/resources/tools/presentation/conf.py index c43b0207a9..7e65dd6aab 100644 --- a/resources/tools/presentation/conf.py +++ b/resources/tools/presentation/conf.py @@ -1,25 +1,26 @@ # -*- coding: utf-8 -*- -# -# CSIT report documentation build configuration file -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. +"""CSIT report documentation build configuration file + +This file is execfile()d with the current directory set to its +containing dir. + +Note that not all possible configuration values are present in this +autogenerated file. + +All configuration values have a default; values that are commented out +serve to show the default. + +If extensions (or modules to document with autodoc) are in another directory, +add these directories to sys.path here. If the directory is relative to the +documentation root, use os.path.abspath to make it absolute, like shown here. +""" import os import sys -sys.path.insert(0, os.path.abspath('.')) +sys.path.insert(0, os.path.abspath(u'.')) # -- General configuration ------------------------------------------------ @@ -30,24 +31,24 @@ sys.path.insert(0, os.path.abspath('.')) # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['sphinxcontrib.programoutput', - 'sphinx.ext.ifconfig'] +extensions = [u'sphinxcontrib.programoutput', + u'sphinx.ext.ifconfig'] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = [u'_templates'] # The suffix(es) of source file names. # You can specify multiple suffix as a list of string: # -source_suffix = ['.rst', '.md'] +source_suffix = [u'.rst', u'.md'] # The master toctree document. -master_doc = 'index' +master_doc = u'index' # General information about the project. -report_week = '41' -project = u'FD.io CSIT-1908.1.{week}'.format(week=report_week) -copyright = u'2019, FD.io' +report_week = u'19' +project = u'FD.io CSIT-1908.2.{week}'.format(week=report_week) +copyright = u'2020, FD.io' author = u'FD.io CSIT' # The version info for the project you're documenting, acts as replacement for @@ -59,88 +60,72 @@ author = u'FD.io CSIT' # The full version, including alpha/beta/rc tags. # release = u'' -rst_epilog = """ +rst_epilog = u""" .. |release-1| replace:: {prev_release} .. |srelease| replace:: {srelease} .. |csit-release| replace:: CSIT-{csitrelease} .. |csit-release-1| replace:: CSIT-{csit_prev_release} .. |vpp-release| replace:: VPP-{vpprelease} release .. |vpp-release-1| replace:: VPP-{vpp_prev_release} release -.. |dpdk-release| replace:: DPDK {dpdkrelease} +.. |dpdk-release| replace:: DPDK-{dpdkrelease} +.. |dpdk-release-1| replace:: DPDK-{dpdk_prev_release} .. |trex-release| replace:: TRex {trex_version} -.. |virl-image-ubuntu| replace:: {csit_ubuntu_ver} -.. |virl-image-centos| replace:: {csit_centos_ver} .. _pdf version of this report: https://docs.fd.io/csit/{release}/report/_static/archive/csit_{release}.{report_week}.pdf .. _tag documentation rst file: https://git.fd.io/csit/tree/docs/tag_documentation.rst?h={release} -.. _TRex intallation: https://git.fd.io/csit/tree/resources/tools/trex/trex_installer.sh?h={release} +.. _TRex installation: https://git.fd.io/csit/tree/resources/tools/trex/trex_installer.sh?h={release} .. _TRex driver: https://git.fd.io/csit/tree/resources/tools/trex/trex_stateless_profile.py?h={release} -.. _VIRL topologies directory: https://git.fd.io/csit/tree/resources/tools/virl/topologies/?h={release} -.. _VIRL ubuntu images lists: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/ubuntu/lists/?h={release} -.. _VIRL centos images lists: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/centos/lists/?h={release} -.. _VIRL nested: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/nested/?h={release} -.. _CSIT Honeycomb Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.func.honeycomb.html -.. _CSIT Honeycomb Performance Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.perf.honeycomb.html .. _CSIT DPDK Performance Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.dpdk.perf.html -.. _CSIT VPP Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.func.html .. _CSIT VPP Performance Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.perf.html -.. _CSIT NSH_SFC Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.nsh_sfc.func.html -.. _CSIT DMM Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.dmm.func.html .. _CSIT VPP Device Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.device.html .. _VPP test framework documentation: https://docs.fd.io/vpp/{vpprelease}/vpp_make_test/html/ .. _FD.io CSIT Testbeds - Xeon Haswell: https://git.fd.io/csit/tree/docs/lab/testbeds_ucs_hsw_hw_bios_cfg.md?h={release} .. _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} +.. _FD.io CSIT testbeds - Xeon Cascade Lake: https://git.fd.io/csit/tree/docs/lab/testbeds_sm_clx_hw_bios_cfg.md?h={release} .. _Ansible inventory - hosts: https://git.fd.io/csit/tree/resources/tools/testbed-setup/ansible/inventories/lf_inventory/host_vars?h={release} .. _FD.io test executor dpdk performance job 3n-hsw: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-verify-{srelease}-3n-hsw .. _FD.io test executor dpdk performance job 3n-skx: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-verify-{srelease}-3n-skx .. _FD.io test executor dpdk performance job 2n-skx: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-verify-{srelease}-2n-skx +.. _FD.io test executor dpdk performance job 2n-clx: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-verify-{srelease}-2n-clx .. _FD.io test executor vpp performance job 3n-hsw: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-{srelease}-3n-hsw .. _FD.io test executor vpp performance job 3n-skx: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-{srelease}-3n-skx .. _FD.io test executor vpp performance job 2n-skx: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-{srelease}-2n-skx .. _FD.io test executor vpp performance job 3n-tsh: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-{srelease}-3n-tsh .. _FD.io test executor vpp performance job 3n-dnv: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-{srelease}-3n-dnv .. _FD.io test executor vpp performance job 2n-dnv: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-{srelease}-2n-dnv -.. _FD.io test executor ligato performance jobs: https://jenkins.fd.io/job/csit-ligato-perf-{srelease}-all -.. _FD.io test executor vpp functional jobs using Ubuntu: https://jenkins.fd.io/view/csit/job/csit-vpp-functional-{srelease}-ubuntu1604-virl -.. _FD.io test executor vpp functional jobs using CentOs: https://jenkins.fd.io/view/csit/job/csit-vpp-functional-{srelease}-centos7-virl +.. _FD.io test executor vpp performance job 2n-clx: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-{srelease}-2n-clx .. _FD.io test executor vpp device jobs using Ubuntu: https://jenkins.fd.io/view/csit/job/csit-vpp-device-{srelease}-ubuntu1804-1n-skx -.. _FD.io test executor Honeycomb functional jobs: https://jenkins.fd.io/view/csit/job/hc2vpp-csit-integration-{srelease}-ubuntu1604 -.. _FD.io test executor NSH_SFC functional jobs: https://jenkins.fd.io/view/csit/job/csit-nsh_sfc-verify-func-{srelease}-ubuntu1604-virl -.. _FD.io test executor DMM functional jobs: https://jenkins.fd.io/view/csit/job/csit-dmm-functional-{srelease}-ubuntu1604-virl -.. _FD.io VPP compile job: https://jenkins.fd.io/view/vpp/job/vpp-merge-{srelease}-ubuntu1604/ -.. _FD.io DPDK compile job: https://jenkins.fd.io/view/deb-dpdk/job/deb_dpdk-merge-{sdpdkrelease}-ubuntu1604/ +.. _FD.io VPP compile job: https://jenkins.fd.io/view/vpp/job/vpp-merge-{srelease}-ubuntu1804/ .. _CSIT Testbed Setup: https://git.fd.io/csit/tree/resources/tools/testbed-setup/README.md?h={release} -.. _K8s configuration files: https://github.com/FDio/csit/tree/{release}/resources/templates/kubernetes .. _VPP startup.conf: https://git.fd.io/vpp/tree/src/vpp/conf/startup.conf?h=stable/{srelease}&id={vpp_release_commit_id} -""".format(release='rls1908_1', +""".format(release=u'rls1908_2', report_week=report_week, - prev_release='rls1904', - srelease='1908_1', - csitrelease='1908.1', - csit_prev_release='1904', - vpprelease='19.08.1', - vpp_prev_release='19.04', - dpdkrelease='19.05', - sdpdkrelease='1905', - trex_version='v2.54', - csit_ubuntu_ver='csit-ubuntu-16.04.1_2019-03-27_2.4', - csit_centos_ver='csit-centos-7.6-1810_2019-05-20_2.5', - vpp_release_commit_id='f4dcae4164f93dac80d4af19af0ee20e712ec673') + prev_release=u'rls1908_1', + srelease=u'1908_2', + csitrelease=u'1908.2', + csit_prev_release=u'1908.1', + vpprelease=u'19.08.2', + vpp_prev_release=u'19.08.1', + dpdkrelease=u'19.08', + dpdk_prev_release=u'19.05', + sdpdkrelease=u'1908', + trex_version=u'v2.73', + vpp_release_commit_id=u'fce396738f865293f0a023bc7f172086f81da456') # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = 'en' +language = u'en' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +exclude_patterns = [u'_build', u'Thumbs.db', u'.DS_Store'] # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = u'sphinx' # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False @@ -150,40 +135,41 @@ todo_include_todos = False # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'sphinx_rtd_theme' +html_theme = u'sphinx_rtd_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. # html_theme_options = { - 'canonical_url': '', - 'analytics_id': '', - 'logo_only': False, - 'display_version': True, - 'prev_next_buttons_location': 'bottom', - 'style_external_links': False, + u'canonical_url': u'', + u'analytics_id': u'', + u'logo_only': False, + u'display_version': True, + u'prev_next_buttons_location': u'bottom', + u'style_external_links': False, # Toc options - 'collapse_navigation': True, - 'sticky_navigation': True, - 'navigation_depth': 3, - 'includehidden': True, - 'titles_only': False + u'collapse_navigation': True, + u'sticky_navigation': True, + u'navigation_depth': 3, + u'includehidden': True, + u'titles_only': False } # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_theme_path = ['env/lib/python2.7/site-packages/sphinx_rtd_theme'] +html_theme_path = [u'env/lib/python3.6/site-packages/sphinx_rtd_theme'] # html_static_path = ['_build/_static'] -html_static_path = ['_tmp/src/_static'] +html_static_path = [u'_tmp/src/_static'] html_context = { - 'css_files': [ - '_static/theme_overrides.css', # overrides for wide tables in RTD theme - ], - } + u'css_files': [ + # overrides for wide tables in RTD theme + u'_static/theme_overrides.css' + ] +} # If false, no module index is generated. html_domain_indices = True @@ -196,59 +182,58 @@ html_split_index = False # -- Options for LaTeX output --------------------------------------------- -latex_engine = 'pdflatex' +latex_engine = u'pdflatex' latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - 'papersize': 'a4paper', - - # The font size ('10pt', '11pt' or '12pt'). - # - #'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # - 'preamble': r''' - \usepackage{pdfpages} - \usepackage{svg} - \usepackage{charter} - \usepackage[defaultsans]{lato} - \usepackage{inconsolata} - \usepackage{csvsimple} - \usepackage{longtable} - \usepackage{booktabs} - ''', - - # Latex figure (float) alignment - # - 'figure_align': 'H', - - # Latex font setup - # - 'fontpkg': r''' - \renewcommand{\familydefault}{\sfdefault} - ''', - - # Latex other setup - # - 'extraclassoptions': 'openany', - 'sphinxsetup': r''' - TitleColor={RGB}{225,38,40}, - InnerLinkColor={RGB}{62,62,63}, - OuterLinkColor={RGB}{225,38,40}, - shadowsep=0pt, - shadowsize=0pt, - shadowrule=0pt - ''' + # The paper size ('letterpaper' or 'a4paper'). + # + u'papersize': u'a4paper', + + # The font size ('10pt', '11pt' or '12pt'). + # + #'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + u'preamble': r''' + \usepackage{pdfpages} + \usepackage{svg} + \usepackage{charter} + \usepackage[defaultsans]{lato} + \usepackage{inconsolata} + \usepackage{csvsimple} + \usepackage{longtable} + \usepackage{booktabs} + ''', + + # Latex figure (float) alignment + # + u'figure_align': u'H', + + # Latex font setup + # + u'fontpkg': r''' + \renewcommand{\familydefault}{\sfdefault} + ''', + + # Latex other setup + # + u'extraclassoptions': u'openany', + u'sphinxsetup': r''' + TitleColor={RGB}{225,38,40}, + InnerLinkColor={RGB}{62,62,63}, + OuterLinkColor={RGB}{225,38,40}, + shadowsep=0pt, + shadowsize=0pt, + shadowrule=0pt + ''' } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'csit.tex', u'CSIT REPORT', - u'', 'manual'), + (master_doc, u'csit.tex', u'CSIT REPORT', u'', u'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -267,7 +252,7 @@ latex_show_pagerefs = True # If true, show URL addresses after external links. # -latex_show_urls = 'footnote' +latex_show_urls = u'footnote' # Documents to append as an appendix to all manuals. # |