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.
23 sys.path.insert(0, os.path.abspath(u'.'))
25 # -- General configuration ------------------------------------------------
27 # If your documentation needs a minimal Sphinx version, state it here.
29 # needs_sphinx = '1.0'
31 # Add any Sphinx extension module names here, as strings. They can be
32 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
34 extensions = [u'sphinxcontrib.programoutput',
35 u'sphinx.ext.ifconfig']
37 # Add any paths that contain templates here, relative to this directory.
38 templates_path = [u'_templates']
40 # The suffix(es) of source file names.
41 # You can specify multiple suffix as a list of string:
43 source_suffix = [u'.rst', u'.md']
45 # The master toctree document.
48 # General information about the project.
50 project = u'FD.io CSIT-2101.{week}'.format(week=report_week)
51 copyright = u'2021, FD.io'
52 author = u'FD.io CSIT'
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
58 # The short X.Y version.
60 # The full version, including alpha/beta/rc tags.
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}
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-tx2: https://jenkins.fd.io/job/csit-dpdk-perf-report-iterative-{srelease}-2n-tx2
93 .. _FD.io test executor dpdk performance job 2n-zn2: https://jenkins.fd.io/job/csit-dpdk-perf-report-iterative-{srelease}-2n-zn2
94 .. _FD.io test executor vpp performance job 3n-hsw: https://jenkins.fd.io/job/csit-vpp-perf-report-iterative-{srelease}-3n-hsw
95 .. _FD.io test executor vpp performance job 3n-skx: https://jenkins.fd.io/job/csit-vpp-perf-report-iterative-{srelease}-3n-skx
96 .. _FD.io test executor vpp performance job 2n-skx: https://jenkins.fd.io/job/csit-vpp-perf-report-iterative-{srelease}-2n-skx
97 .. _FD.io test executor vpp performance job 3n-tsh: https://jenkins.fd.io/job/csit-vpp-perf-report-iterative-{srelease}-3n-tsh
98 .. _FD.io test executor vpp performance job 2n-tx2: https://jenkins.fd.io/job/csit-vpp-perf-report-iterative-{srelease}-2n-tx2
99 .. _FD.io test executor vpp performance job 3n-dnv: https://jenkins.fd.io/job/csit-vpp-perf-report-iterative-{srelease}-3n-dnv
100 .. _FD.io test executor vpp performance job 2n-dnv: https://jenkins.fd.io/job/csit-vpp-perf-report-iterative-{srelease}-2n-dnv
101 .. _FD.io test executor vpp performance job 2n-clx: https://jenkins.fd.io/job/csit-vpp-perf-report-iterative-{srelease}-2n-clx
102 .. _FD.io test executor vpp performance job 2n-zn2: https://jenkins.fd.io/job/csit-vpp-perf-report-iterative-{srelease}-2n-zn2
103 .. _FD.io test executor vpp device jobs using Ubuntu: https://jenkins.fd.io/view/csit/job/csit-vpp-device-{srelease}-ubuntu1804-1n-skx
104 .. _FD.io VPP compile job: https://jenkins.fd.io/view/vpp/job/vpp-merge-{srelease}-ubuntu1804-x86_64/
105 .. _CSIT Testbed Setup: https://git.fd.io/csit/tree/resources/tools/testbed-setup/README.md?h={release}
106 .. _VPP startup.conf: https://git.fd.io/vpp/tree/src/vpp/conf/startup.conf?h=stable/{srelease}&id={vpp_release_commit_id}
107 """.format(release=u'rls2101',
108 report_week=report_week,
109 prev_release=u'rls2009',
112 csit_prev_release=u'2009',
114 vpp_prev_release=u'20.09',
115 dpdkrelease=u'20.11',
116 dpdk_prev_release=u'20.08',
117 sdpdkrelease=u'2011',
118 trex_version=u'v2.86',
119 vpp_release_commit_id=u'072def4738f149a6e3f2f3884fae55690d6ad3a1')
121 # The language for content autogenerated by Sphinx. Refer to documentation
122 # for a list of supported languages.
124 # This is also used if you do content translation via gettext catalogs.
125 # Usually you set "language" from the command line for these cases.
128 # List of patterns, relative to source directory, that match files and
129 # directories to ignore when looking for source files.
130 # This patterns also effect to html_static_path and html_extra_path
131 exclude_patterns = [u'_build', u'Thumbs.db', u'.DS_Store']
133 # The name of the Pygments (syntax highlighting) style to use.
134 pygments_style = u'sphinx'
136 # If true, `todo` and `todoList` produce output, else they produce nothing.
137 todo_include_todos = False
139 # -- Options for HTML output ----------------------------------------------
141 # The theme to use for HTML and HTML Help pages. See the documentation for
142 # a list of builtin themes.
144 html_theme = u'sphinx_rtd_theme'
146 # Theme options are theme-specific and customize the look and feel of a theme
147 # further. For a list of options available for each theme, see the
150 html_theme_options = {
151 u'canonical_url': u'',
152 u'analytics_id': u'',
154 u'display_version': True,
155 u'prev_next_buttons_location': u'bottom',
156 u'style_external_links': False,
158 u'collapse_navigation': True,
159 u'sticky_navigation': True,
160 u'navigation_depth': 3,
161 u'includehidden': True,
162 u'titles_only': False
165 # Add any paths that contain custom static files (such as style sheets) here,
166 # relative to this directory. They are copied after the builtin static files,
167 # so a file named "default.css" will overwrite the builtin "default.css".
168 html_theme_path = [u'env/lib/python3.6/site-packages/sphinx_rtd_theme']
170 # html_static_path = ['_build/_static']
171 html_static_path = [u'_tmp/src/_static']
175 # overrides for wide tables in RTD theme
176 u'_static/theme_overrides.css'
180 # If false, no module index is generated.
181 html_domain_indices = True
183 # If false, no index is generated.
184 html_use_index = True
186 # If true, the index is split into individual pages for each letter.
187 html_split_index = False
189 # -- Options for LaTeX output ---------------------------------------------
191 latex_engine = u'pdflatex'
194 # The paper size ('letterpaper' or 'a4paper').
196 u'papersize': u'a4paper',
198 # The font size ('10pt', '11pt' or '12pt').
200 #'pointsize': '10pt',
202 # Additional stuff for the LaTeX preamble.
205 \usepackage{pdfpages}
208 \usepackage[defaultsans]{lato}
209 \usepackage{inconsolata}
210 \usepackage{csvsimple}
211 \usepackage{longtable}
212 \usepackage{booktabs}
215 # Latex figure (float) alignment
217 u'figure_align': u'H',
222 \renewcommand{\familydefault}{\sfdefault}
227 u'extraclassoptions': u'openany',
229 TitleColor={RGB}{225,38,40},
230 InnerLinkColor={RGB}{62,62,63},
231 OuterLinkColor={RGB}{225,38,40},
238 # Grouping the document tree into LaTeX files. List of tuples
239 # (source start file, target name, title,
240 # author, documentclass [howto, manual, or own class]).
242 (master_doc, u'csit.tex', u'CSIT REPORT', u'', u'manual'),
245 # The name of an image file (relative to this directory) to place at the top of
248 # latex_logo = 'fdio.pdf'
250 # For "manual" documents, if this is true, then toplevel headings are parts,
253 # latex_use_parts = True
255 # If true, show page references after internal links.
257 latex_show_pagerefs = True
259 # If true, show URL addresses after external links.
261 latex_show_urls = u'footnote'
263 # Documents to append as an appendix to all manuals.
265 # latex_appendices = []
267 # It false, will not define \strong, \code, itleref, \crossref ... but only
268 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
271 # latex_keep_old_macro_names = True
273 # If false, no module index is generated.
275 # latex_domain_indices = True