1 # -*- coding: utf-8 -*-
3 """CSIT report documentation build configuration file
5 This file is execfile()d with the current directory set to its
8 Note that not all possible configuration values are present in this
11 All configuration values have a default; values that are commented out
12 serve to show the default.
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.
22 import sphinx_rtd_theme
24 sys.path.insert(0, os.path.abspath('.'))
26 # -- General configuration ------------------------------------------------
28 # If your documentation needs a minimal Sphinx version, state it here.
30 # needs_sphinx = '1.0'
32 # Add any Sphinx extension module names here, as strings. They can be
33 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
36 'sphinxcontrib.programoutput',
37 'sphinx.ext.ifconfig',
41 # Add any paths that contain templates here, relative to this directory.
42 templates_path = ['_templates']
44 # The suffix(es) of source file names.
45 # You can specify multiple suffix as a list of string:
47 source_suffix = ['.rst', '.md']
49 # The master toctree document.
52 # General information about the project.
54 project = 'FD.io CSIT-2210.{week}'.format(week=report_week)
55 copyright = '2022, FD.io'
58 # The version info for the project yo're documenting, acts as replacement for
59 # |version| and |release|, also used in various other places throughout the
62 # The short X.Y version.
64 # The full version, including alpha/beta/rc tags.
68 .. |release-1| replace:: {prev_release}
69 .. |srelease| replace:: {srelease}
70 .. |csit-release| replace:: CSIT-{csitrelease}
71 .. |csit-release-1| replace:: CSIT-{csit_prev_release}
72 .. |vpp-release| replace:: VPP-{vpprelease} release
73 .. |vpp-release-1| replace:: VPP-{vpp_prev_release} release
74 .. |dpdk-release| replace:: DPDK-{dpdkrelease}
75 .. |dpdk-release-1| replace:: DPDK-{dpdk_prev_release}
76 .. |trex-release| replace:: TRex {trex_version}
78 .. _pdf version of this report: https://s3-docs.fd.io/csit/{release}/report/_static/archive/csit_{release}.{report_week}.pdf
79 .. _tag documentation rst file: https://git.fd.io/csit/tree/docs/tag_documentation.rst?h={release}
80 .. _TRex driver: https://git.fd.io/csit/tree/GPL/tools/trex/trex_stl_profile.py?h={release}
81 .. _CSIT Performance Tests Documentation: https://s3-docs.fd.io/csit/{release}/docs/index.html
82 .. _VPP test framework documentation: https://docs.fd.io/vpp/{vpprelease}/vpp_make_test/html/
83 .. _FD.io CSIT testbeds - Atom Snowridge: https://git.fd.io/csit/tree/docs/lab/testbeds_sm_snr_hw_bios_cfg.md?h={release}
84 .. _FD.io CSIT testbeds - Atom Denverton: https://git.fd.io/csit/tree/docs/lab/testbeds_sm_dnv_hw_bios_cfg.md?h={release}
85 .. _FD.io CSIT testbeds - EPYC Zen2: https://git.fd.io/csit/tree/docs/lab/testbeds_sm_zn2_hw_bios_cfg.md?h={release}
86 .. _FD.io CSIT testbeds - Xeon Ice Lake: https://git.fd.io/csit/tree/docs/lab/testbeds_sm_icx_hw_bios_cfg.md?h={release}
87 .. _FD.io CSIT testbeds - Xeon Cascade Lake: https://git.fd.io/csit/tree/docs/lab/testbeds_sm_clx_hw_bios_cfg.md?h={release}
88 .. _Ansible inventory - hosts: https://git.fd.io/csit/tree/fdio.infra.ansible/inventories/lf_inventory/host_vars?h={release}
89 .. _build logs from FD.io trex performance job 1n-aws: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-trex-perf-report-iterative-{srelease}-1n-aws
90 .. _build logs from FD.io trex performance job 2n-icx: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-trex-perf-report-iterative-{srelease}-2n-icx
91 .. _build logs from FD.io dpdk performance job 2n-icx: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-dpdk-perf-report-iterative-{srelease}-2n-icx
92 .. _build logs from FD.io dpdk performance job 3n-icx: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-dpdk-perf-report-iterative-{srelease}-3n-icx
93 .. _build logs from FD.io dpdk performance job 2n-clx: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-dpdk-perf-report-iterative-{srelease}-2n-clx
94 .. _build logs from FD.io dpdk performance job 2n-dnv: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-dpdk-perf-report-iterative-{srelease}-2n-dnv
95 .. _build logs from FD.io dpdk performance job 3n-dnv: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-dpdk-perf-report-iterative-{srelease}-3n-dnv
96 .. _build logs from FD.io dpdk performance job 3n-alt: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-dpdk-perf-report-iterative-{srelease}-3n-alt
97 .. _build logs from FD.io dpdk performance job 3n-tsh: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-dpdk-perf-report-iterative-{srelease}-3n-tsh
98 .. _build logs from FD.io dpdk performance job 2n-tx2: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-dpdk-perf-report-iterative-{srelease}-2n-tx2
99 .. _build logs from FD.io dpdk performance job 2n-zn2: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-dpdk-perf-report-iterative-{srelease}-2n-zn2
100 .. _build logs from FD.io vpp performance job 3n-alt: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-perf-report-iterative-{srelease}-3n-alt
101 .. _build logs from FD.io vpp performance job 3n-tsh: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-perf-report-iterative-{srelease}-3n-tsh
102 .. _build logs from FD.io vpp performance job 2n-tx2: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-perf-report-iterative-{srelease}-2n-tx2
103 .. _build logs from FD.io vpp performance job 3n-dnv: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-perf-report-iterative-{srelease}-3n-dnv
104 .. _build logs from FD.io vpp performance job 2n-dnv: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-perf-report-iterative-{srelease}-2n-dnv
105 .. _build logs from FD.io vpp performance job 2n-clx: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-perf-report-iterative-{srelease}-2n-clx
106 .. _build logs from FD.io vpp performance job 2n-icx: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-perf-report-iterative-{srelease}-2n-icx
107 .. _build logs from FD.io vpp performance job 3n-icx: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-perf-report-iterative-{srelease}-3n-icx
108 .. _build logs from FD.io vpp performance job 2n-zn2: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-perf-report-iterative-{srelease}-2n-zn2
109 .. _build logs from FD.io vpp performance job 3n-aws: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-perf-report-iterative-{srelease}-3n-aws
110 .. _build logs from FD.io vpp performance job 2n-aws: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-perf-report-iterative-{srelease}-2n-aws
111 .. _build logs from FD.io dpdk coverage job 2n-icx: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-dpdk-perf-report-coverage-{srelease}-2n-icx
112 .. _build logs from FD.io dpdk coverage job 3n-icx: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-dpdk-perf-report-coverage-{srelease}-3n-icx
113 .. _build logs from FD.io dpdk coverage job 2n-clx: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-dpdk-perf-report-coverage-{srelease}-2n-clx
114 .. _build logs from FD.io dpdk coverage job 2n-dnv: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-dpdk-perf-report-coverage-{srelease}-2n-dnv
115 .. _build logs from FD.io dpdk coverage job 3n-dnv: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-dpdk-perf-report-coverage-{srelease}-3n-dnv
116 .. _build logs from FD.io dpdk coverage job 3n-alt: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-dpdk-perf-report-coverage-{srelease}-3n-alt
117 .. _build logs from FD.io dpdk coverage job 3n-tsh: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-dpdk-perf-report-coverage-{srelease}-3n-tsh
118 .. _build logs from FD.io dpdk coverage job 2n-tx2: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-dpdk-perf-report-coverage-{srelease}-2n-tx2
119 .. _build logs from FD.io dpdk coverage job 2n-zn2: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-dpdk-perf-report-coverage-{srelease}-2n-zn2
120 .. _build logs from FD.io trex coverage job 1n-aws: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-trex-perf-report-coverage-{srelease}-1n-aws
121 .. _build logs from FD.io trex coverage job 2n-icx: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-trex-perf-report-coverage-{srelease}-2n-icx
122 .. _build logs from FD.io vpp coverage job 3n-alt: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-perf-report-coverage-{srelease}-3n-alt
123 .. _build logs from FD.io vpp coverage job 3n-tsh: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-perf-report-coverage-{srelease}-3n-tsh
124 .. _build logs from FD.io vpp coverage job 2n-tx2: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-perf-report-coverage-{srelease}-2n-tx2
125 .. _build logs from FD.io vpp coverage job 3n-dnv: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-perf-report-coverage-{srelease}-3n-dnv
126 .. _build logs from FD.io vpp coverage job 2n-dnv: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-perf-report-coverage-{srelease}-2n-dnv
127 .. _build logs from FD.io vpp coverage job 2n-clx: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-perf-report-coverage-{srelease}-2n-clx
128 .. _build logs from FD.io vpp coverage job 2n-icx: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-perf-report-coverage-{srelease}-2n-icx
129 .. _build logs from FD.io vpp coverage job 3n-icx: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-perf-report-coverage-{srelease}-3n-icx
130 .. _build logs from FD.io vpp coverage job 2n-zn2: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-perf-report-coverage-{srelease}-2n-zn2
131 .. _build logs from FD.io vpp coverage job 3n-aws: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-perf-report-coverage-{srelease}-3n-aws
132 .. _build logs from FD.io vpp coverage job 2n-aws: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-perf-report-coverage-{srelease}-2n-aws
133 .. _build logs from FD.io vpp device jobs using Ubuntu: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-device-{srelease}-ubuntu2004-1n-skx
134 .. _FD.io VPP compile job: https://jenkins.fd.io/view/vpp/job/vpp-merge-{srelease}-ubuntu2004-x86_64/
135 .. _CSIT Testbed Setup: https://git.fd.io/csit/tree/fdio.infra.ansible?h={release}
136 .. _VPP startup.conf: https://git.fd.io/vpp/tree/src/vpp/conf/startup.conf?h=stable/{srelease}&id={vpp_release_commit_id}
137 """.format(release='rls2210',
138 report_week=report_week,
139 prev_release='rls2206',
142 csit_prev_release='2206',
144 vpp_prev_release='22.06',
146 dpdk_prev_release='22.03',
147 sdpdkrelease='22.07',
148 trex_version='v3.00',
149 vpp_release_commit_id='07e0c05e698cf5ffd1e2d2de0296d1907519dc3d')
151 # The language for content autogenerated by Sphinx. Refer to documentation
152 # for a list of supported languages.
154 # This is also used if you do content translation via gettext catalogs.
155 # Usually you set "language" from the command line for these cases.
158 # List of patterns, relative to source directory, that match files and
159 # directories to ignore when looking for source files.
160 # This patterns also effect to html_static_path and html_extra_path
161 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
163 # The name of the Pygments (syntax highlighting) style to use.
164 pygments_style = 'sphinx'
166 # If true, `todo` and `todoList` produce output, else they produce nothing.
167 todo_include_todos = False
169 # -- Options for HTML output ----------------------------------------------
171 # The theme to use for HTML and HTML Help pages. See the documentation for
172 # a list of builtin themes.
174 html_theme = 'sphinx_rtd_theme'
176 # Theme options are theme-specific and customize the look and feel of a theme
177 # further. For a list of options available for each theme, see the
180 html_theme_options = {
182 'analytics_anonymize_ip': False,
184 'display_version': True,
185 'prev_next_buttons_location': 'bottom',
186 'style_external_links': False,
187 'vcs_pageview_mode': '',
188 'style_nav_header_background': '#2980b9',
190 'collapse_navigation': True,
191 'sticky_navigation': True,
192 'navigation_depth': 4,
193 'includehidden': True,
197 # Add any paths that contain custom static files (such as style sheets) here,
198 # relative to this directory. They are copied after the builtin static files,
199 # so a file named "default.css" will overwrite the builtin "default.css".
201 html_static_path = ['_tmp/src/_static']
205 '_static/css/theme.css',
206 '_static/css/badge_only.css',
207 # overrides for wide tables in RTD theme
208 '_static/theme_overrides.css',
212 # If false, no module index is generated.
213 html_domain_indices = True
215 # If false, no index is generated.
216 html_use_index = True
218 # If true, the index is split into individual pages for each letter.
219 html_split_index = False
221 # -- Options for LaTeX output ---------------------------------------------
223 latex_engine = 'pdflatex'
226 # The paper size ('letterpaper' or 'a4paper').
228 'papersize': 'a4paper',
230 # The font size ('10pt', '11pt' or '12pt').
232 #'pointsize': '10pt',
234 # Additional stuff for the LaTeX preamble.
237 \usepackage{pdfpages}
240 \usepackage[defaultsans]{lato}
241 \usepackage{inconsolata}
242 \usepackage{csvsimple}
243 \usepackage{longtable}
244 \usepackage{booktabs}
247 # Latex figure (float) alignment
254 \renewcommand{\familydefault}{\sfdefault}
259 'extraclassoptions': 'openany',
261 TitleColor={RGB}{225,38,40},
262 InnerLinkColor={RGB}{62,62,63},
263 OuterLinkColor={RGB}{225,38,40},
270 # Grouping the document tree into LaTeX files. List of tuples
271 # (source start file, target name, title,
272 # author, documentclass [howto, manual, or own class]).
274 (master_doc, 'csit.tex', 'CSIT REPORT', '', 'manual'),
277 # The name of an image file (relative to this directory) to place at the top of
280 # latex_logo = 'fdio.pdf'
282 # For "manual" documents, if this is true, then toplevel headings are parts,
285 # latex_use_parts = True
287 # If true, show page references after internal links.
289 latex_show_pagerefs = True
291 # If true, show URL addresses after external links.
293 latex_show_urls = 'footnote'
295 # Documents to append as an appendix to all manuals.
297 # latex_appendices = []
299 # It false, will not define \strong, \code, itleref, \crossref ... but only
300 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
303 # latex_keep_old_macro_names = True
305 # If false, no module index is generated.
307 # latex_domain_indices = True