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