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-2001.{week}'.format(week=report_week)
51 copyright = u'2020, 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 .. |trex-release| replace:: TRex {trex_version}
73 .. _pdf version of this report: https://docs.fd.io/csit/{release}/report/_static/archive/csit_{release}.{report_week}.pdf
74 .. _tag documentation rst file: https://git.fd.io/csit/tree/docs/tag_documentation.rst?h={release}
75 .. _TRex installation: https://git.fd.io/csit/tree/resources/tools/trex/trex_installer.sh?h={release}
76 .. _TRex driver: https://git.fd.io/csit/tree/resources/tools/trex/trex_stateless_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 Cascadelake: 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/view/csit/job/csit-dpdk-perf-verify-{srelease}-3n-hsw
86 .. _FD.io test executor dpdk performance job 3n-skx: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-verify-{srelease}-3n-skx
87 .. _FD.io test executor dpdk performance job 2n-skx: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-verify-{srelease}-2n-skx
88 .. _FD.io test executor dpdk performance job 2n-clx: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-verify-{srelease}-2n-clx
89 .. _FD.io test executor vpp performance job 3n-hsw: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-{srelease}-3n-hsw
90 .. _FD.io test executor vpp performance job 3n-skx: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-{srelease}-3n-skx
91 .. _FD.io test executor vpp performance job 2n-skx: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-{srelease}-2n-skx
92 .. _FD.io test executor vpp performance job 3n-tsh: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-{srelease}-3n-tsh
93 .. _FD.io test executor vpp performance job 3n-dnv: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-{srelease}-3n-dnv
94 .. _FD.io test executor vpp performance job 2n-dnv: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-{srelease}-2n-dnv
95 .. _FD.io test executor vpp performance job 2n-clx: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-{srelease}-2n-clx
96 .. _FD.io test executor vpp device jobs using Ubuntu: https://jenkins.fd.io/view/csit/job/csit-vpp-device-{srelease}-ubuntu1804-1n-skx
97 .. _FD.io VPP compile job: https://jenkins.fd.io/view/vpp/job/vpp-merge-{srelease}-ubuntu1804/
98 .. _CSIT Testbed Setup: https://git.fd.io/csit/tree/resources/tools/testbed-setup/README.md?h={release}
99 .. _VPP startup.conf: https://git.fd.io/vpp/tree/src/vpp/conf/startup.conf?h=stable/{srelease}&id={vpp_release_commit_id}
100 """.format(release=u'rls2001',
101 report_week=report_week,
102 prev_release=u'rls1908',
105 csit_prev_release=u'1908',
107 vpp_prev_release=u'19.08',
108 dpdkrelease=u'19.08',
109 sdpdkrelease=u'1908',
110 trex_version=u'v2.73',
111 vpp_release_commit_id=u'1c586de48cc76fc6eac50f5d87003e2a80aa43e7')
113 # The language for content autogenerated by Sphinx. Refer to documentation
114 # for a list of supported languages.
116 # This is also used if you do content translation via gettext catalogs.
117 # Usually you set "language" from the command line for these cases.
120 # List of patterns, relative to source directory, that match files and
121 # directories to ignore when looking for source files.
122 # This patterns also effect to html_static_path and html_extra_path
123 exclude_patterns = [u'_build', u'Thumbs.db', u'.DS_Store']
125 # The name of the Pygments (syntax highlighting) style to use.
126 pygments_style = u'sphinx'
128 # If true, `todo` and `todoList` produce output, else they produce nothing.
129 todo_include_todos = False
131 # -- Options for HTML output ----------------------------------------------
133 # The theme to use for HTML and HTML Help pages. See the documentation for
134 # a list of builtin themes.
136 html_theme = u'sphinx_rtd_theme'
138 # Theme options are theme-specific and customize the look and feel of a theme
139 # further. For a list of options available for each theme, see the
142 html_theme_options = {
143 u'canonical_url': u'',
144 u'analytics_id': u'',
146 u'display_version': True,
147 u'prev_next_buttons_location': u'bottom',
148 u'style_external_links': False,
150 u'collapse_navigation': True,
151 u'sticky_navigation': True,
152 u'navigation_depth': 3,
153 u'includehidden': True,
154 u'titles_only': False
157 # Add any paths that contain custom static files (such as style sheets) here,
158 # relative to this directory. They are copied after the builtin static files,
159 # so a file named "default.css" will overwrite the builtin "default.css".
160 html_theme_path = [u'env/lib/python3.6/site-packages/sphinx_rtd_theme']
162 # html_static_path = ['_build/_static']
163 html_static_path = [u'_tmp/src/_static']
167 # overrides for wide tables in RTD theme
168 u'_static/theme_overrides.css'
172 # If false, no module index is generated.
173 html_domain_indices = True
175 # If false, no index is generated.
176 html_use_index = True
178 # If true, the index is split into individual pages for each letter.
179 html_split_index = False
181 # -- Options for LaTeX output ---------------------------------------------
183 latex_engine = u'pdflatex'
186 # The paper size ('letterpaper' or 'a4paper').
188 u'papersize': u'a4paper',
190 # The font size ('10pt', '11pt' or '12pt').
192 #'pointsize': '10pt',
194 # Additional stuff for the LaTeX preamble.
197 \usepackage{pdfpages}
200 \usepackage[defaultsans]{lato}
201 \usepackage{inconsolata}
202 \usepackage{csvsimple}
203 \usepackage{longtable}
204 \usepackage{booktabs}
207 # Latex figure (float) alignment
209 u'figure_align': u'H',
214 \renewcommand{\familydefault}{\sfdefault}
219 u'extraclassoptions': u'openany',
221 TitleColor={RGB}{225,38,40},
222 InnerLinkColor={RGB}{62,62,63},
223 OuterLinkColor={RGB}{225,38,40},
230 # Grouping the document tree into LaTeX files. List of tuples
231 # (source start file, target name, title,
232 # author, documentclass [howto, manual, or own class]).
234 (master_doc, u'csit.tex', u'CSIT REPORT', u'', u'manual'),
237 # The name of an image file (relative to this directory) to place at the top of
240 # latex_logo = 'fdio.pdf'
242 # For "manual" documents, if this is true, then toplevel headings are parts,
245 # latex_use_parts = True
247 # If true, show page references after internal links.
249 latex_show_pagerefs = True
251 # If true, show URL addresses after external links.
253 latex_show_urls = u'footnote'
255 # Documents to append as an appendix to all manuals.
257 # latex_appendices = []
259 # It false, will not define \strong, \code, itleref, \crossref ... but only
260 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
263 # latex_keep_old_macro_names = True
265 # If false, no module index is generated.
267 # latex_domain_indices = True