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-2302.{week}'.format(week=report_week)
55 copyright = '2023, 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 - EPYC Zen2: https://git.fd.io/csit/tree/docs/lab/testbeds_sm_zn2_hw_bios_cfg.md?h={release}
85 .. _FD.io CSIT testbeds - Xeon Ice Lake: https://git.fd.io/csit/tree/docs/lab/testbeds_sm_icx_hw_bios_cfg.md?h={release}
86 .. _FD.io CSIT testbeds - Xeon Cascade Lake: https://git.fd.io/csit/tree/docs/lab/testbeds_sm_clx_hw_bios_cfg.md?h={release}
87 .. _Ansible inventory - hosts: https://git.fd.io/csit/tree/fdio.infra.ansible/inventories/lf_inventory/host_vars?h={release}
88 .. _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
89 .. _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
90 .. _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
91 .. _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
92 .. _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
93 .. _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
94 .. _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
95 .. _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
96 .. _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
97 .. _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
98 .. _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
99 .. _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
100 .. _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
101 .. _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
102 .. _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
103 .. _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
104 .. _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
105 .. _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
106 .. _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
107 .. _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
108 .. _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
109 .. _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
110 .. _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
111 .. _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
112 .. _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
113 .. _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
114 .. _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
115 .. _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
116 .. _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
117 .. _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
118 .. _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
119 .. _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
120 .. _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
121 .. _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
122 .. _build logs from FD.io vpp device job 1n-skx: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-device-{srelease}-ubuntu2204-x86_64-1n-skx
123 .. _build logs from FD.io vpp device job 1n-tx2: https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-vpp-device-{srelease}-ubuntu2204-aarch64-1n-tx2
124 .. _FD.io VPP compile job: https://jenkins.fd.io/view/vpp/job/vpp-merge-{srelease}-ubuntu2004-x86_64/
125 .. _CSIT Testbed Setup: https://git.fd.io/csit/tree/fdio.infra.ansible?h={release}
126 .. _VPP startup.conf: https://git.fd.io/vpp/tree/src/vpp/conf/startup.conf?h=stable/{srelease}&id={vpp_release_commit_id}
127 """.format(release='rls2302',
128 report_week=report_week,
129 prev_release='rls2210',
132 csit_prev_release='2210',
134 vpp_prev_release='22.10',
136 dpdk_prev_release='22.03',
137 sdpdkrelease='22.07',
138 trex_version='v3.00',
139 vpp_release_commit_id='07e0c05e698cf5ffd1e2d2de0296d1907519dc3d')
141 # The language for content autogenerated by Sphinx. Refer to documentation
142 # for a list of supported languages.
144 # This is also used if you do content translation via gettext catalogs.
145 # Usually you set "language" from the command line for these cases.
148 # List of patterns, relative to source directory, that match files and
149 # directories to ignore when looking for source files.
150 # This patterns also effect to html_static_path and html_extra_path
151 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
153 # The name of the Pygments (syntax highlighting) style to use.
154 pygments_style = 'sphinx'
156 # If true, `todo` and `todoList` produce output, else they produce nothing.
157 todo_include_todos = False
159 # -- Options for HTML output ----------------------------------------------
161 # The theme to use for HTML and HTML Help pages. See the documentation for
162 # a list of builtin themes.
164 html_theme = 'sphinx_rtd_theme'
166 # Theme options are theme-specific and customize the look and feel of a theme
167 # further. For a list of options available for each theme, see the
170 html_theme_options = {
172 'analytics_anonymize_ip': False,
174 'display_version': True,
175 'prev_next_buttons_location': 'bottom',
176 'style_external_links': False,
177 'vcs_pageview_mode': '',
178 'style_nav_header_background': '#2980b9',
180 'collapse_navigation': True,
181 'sticky_navigation': True,
182 'navigation_depth': 4,
183 'includehidden': True,
187 # Add any paths that contain custom static files (such as style sheets) here,
188 # relative to this directory. They are copied after the builtin static files,
189 # so a file named "default.css" will overwrite the builtin "default.css".
191 html_static_path = ['_tmp/src/_static']
195 '_static/css/theme.css',
196 '_static/css/badge_only.css',
197 # overrides for wide tables in RTD theme
198 '_static/theme_overrides.css',
202 # If false, no module index is generated.
203 html_domain_indices = True
205 # If false, no index is generated.
206 html_use_index = True
208 # If true, the index is split into individual pages for each letter.
209 html_split_index = False
211 # -- Options for LaTeX output ---------------------------------------------
213 latex_engine = 'pdflatex'
216 # The paper size ('letterpaper' or 'a4paper').
218 'papersize': 'a4paper',
220 # The font size ('10pt', '11pt' or '12pt').
222 #'pointsize': '10pt',
224 # Additional stuff for the LaTeX preamble.
227 \usepackage{pdfpages}
230 \usepackage[defaultsans]{lato}
231 \usepackage{inconsolata}
232 \usepackage{csvsimple}
233 \usepackage{longtable}
234 \usepackage{booktabs}
237 # Latex figure (float) alignment
244 \renewcommand{\familydefault}{\sfdefault}
249 'extraclassoptions': 'openany',
251 TitleColor={RGB}{225,38,40},
252 InnerLinkColor={RGB}{62,62,63},
253 OuterLinkColor={RGB}{225,38,40},
260 # Grouping the document tree into LaTeX files. List of tuples
261 # (source start file, target name, title,
262 # author, documentclass [howto, manual, or own class]).
264 (master_doc, 'csit.tex', 'CSIT REPORT', '', 'manual'),
267 # The name of an image file (relative to this directory) to place at the top of
270 # latex_logo = 'fdio.pdf'
272 # For "manual" documents, if this is true, then toplevel headings are parts,
275 # latex_use_parts = True
277 # If true, show page references after internal links.
279 latex_show_pagerefs = True
281 # If true, show URL addresses after external links.
283 latex_show_urls = 'footnote'
285 # Documents to append as an appendix to all manuals.
287 # latex_appendices = []
289 # It false, will not define \strong, \code, itleref, \crossref ... but only
290 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
293 # latex_keep_old_macro_names = True
295 # If false, no module index is generated.
297 # latex_domain_indices = True