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-1908.{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}
72 .. |virl-image-ubuntu| replace:: {csit_ubuntu_ver}
73 .. |virl-image-centos| replace:: {csit_centos_ver}
75 .. _pdf version of this report: https://docs.fd.io/csit/{release}/report/_static/archive/csit_{release}.{report_week}.pdf
76 .. _tag documentation rst file: https://git.fd.io/csit/tree/docs/tag_documentation.rst?h={release}
77 .. _TRex intallation: https://git.fd.io/csit/tree/resources/tools/trex/trex_installer.sh?h={release}
78 .. _TRex driver: https://git.fd.io/csit/tree/resources/tools/trex/trex_stateless_profile.py?h={release}
79 .. _VIRL topologies directory: https://git.fd.io/csit/tree/resources/tools/virl/topologies/?h={release}
80 .. _VIRL ubuntu images lists: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/ubuntu/lists/?h={release}
81 .. _VIRL centos images lists: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/centos/lists/?h={release}
82 .. _VIRL nested: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/nested/?h={release}
83 .. _CSIT DPDK Performance Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.dpdk.perf.html
84 .. _CSIT VPP Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.func.html
85 .. _CSIT VPP Performance Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.perf.html
86 .. _CSIT VPP Device Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.device.html
87 .. _VPP test framework documentation: https://docs.fd.io/vpp/{vpprelease}/vpp_make_test/html/
88 .. _FD.io CSIT Testbeds - Xeon Haswell: https://git.fd.io/csit/tree/docs/lab/testbeds_ucs_hsw_hw_bios_cfg.md?h={release}
89 .. _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}
90 .. _FD.io CSIT testbeds - Xeon Cascadelake: https://git.fd.io/csit/tree/docs/lab/testbeds_sm_clx_hw_bios_cfg.md?h={release}
91 .. _Ansible inventory - hosts: https://git.fd.io/csit/tree/resources/tools/testbed-setup/ansible/inventories/lf_inventory/host_vars?h={release}
92 .. _FD.io test executor dpdk performance job 3n-hsw: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-verify-{srelease}-3n-hsw
93 .. _FD.io test executor dpdk performance job 3n-skx: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-verify-{srelease}-3n-skx
94 .. _FD.io test executor dpdk performance job 2n-skx: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-verify-{srelease}-2n-skx
95 .. _FD.io test executor vpp performance job 3n-hsw: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-{srelease}-3n-hsw
96 .. _FD.io test executor vpp performance job 3n-skx: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-{srelease}-3n-skx
97 .. _FD.io test executor vpp performance job 2n-skx: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-{srelease}-2n-skx
98 .. _FD.io test executor vpp performance job 3n-tsh: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-{srelease}-3n-tsh
99 .. _FD.io test executor vpp performance job 3n-dnv: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-{srelease}-3n-dnv
100 .. _FD.io test executor vpp performance job 2n-dnv: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-{srelease}-2n-dnv
101 .. _FD.io test executor vpp functional jobs using Ubuntu: https://jenkins.fd.io/view/csit/job/csit-vpp-functional-{srelease}-ubuntu1604-virl
102 .. _FD.io test executor vpp functional jobs using CentOs: https://jenkins.fd.io/view/csit/job/csit-vpp-functional-{srelease}-centos7-virl
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}-ubuntu1604/
105 .. _FD.io DPDK compile job: https://jenkins.fd.io/view/deb-dpdk/job/deb_dpdk-merge-{sdpdkrelease}-ubuntu1604/
106 .. _CSIT Testbed Setup: https://git.fd.io/csit/tree/resources/tools/testbed-setup/README.md?h={release}
107 .. _VPP startup.conf: https://git.fd.io/vpp/tree/src/vpp/conf/startup.conf?h=stable/{srelease}&id={vpp_release_commit_id}
108 """.format(release=u'rls1908',
109 report_week=report_week,
110 prev_release=u'rls1904',
113 csit_prev_release=u'1904',
115 vpp_prev_release=u'19.04',
116 dpdkrelease=u'19.05',
117 sdpdkrelease=u'1905',
118 trex_version=u'v2.54',
119 csit_ubuntu_ver=u'csit-ubuntu-16.04.1_2019-03-27_2.4',
120 csit_centos_ver=u'csit-centos-7.6-1810_2019-05-20_2.5',
121 vpp_release_commit_id=u'1c586de48cc76fc6eac50f5d87003e2a80aa43e7')
123 # The language for content autogenerated by Sphinx. Refer to documentation
124 # for a list of supported languages.
126 # This is also used if you do content translation via gettext catalogs.
127 # Usually you set "language" from the command line for these cases.
130 # List of patterns, relative to source directory, that match files and
131 # directories to ignore when looking for source files.
132 # This patterns also effect to html_static_path and html_extra_path
133 exclude_patterns = [u'_build', u'Thumbs.db', u'.DS_Store']
135 # The name of the Pygments (syntax highlighting) style to use.
136 pygments_style = u'sphinx'
138 # If true, `todo` and `todoList` produce output, else they produce nothing.
139 todo_include_todos = False
141 # -- Options for HTML output ----------------------------------------------
143 # The theme to use for HTML and HTML Help pages. See the documentation for
144 # a list of builtin themes.
146 html_theme = u'sphinx_rtd_theme'
148 # Theme options are theme-specific and customize the look and feel of a theme
149 # further. For a list of options available for each theme, see the
152 html_theme_options = {
153 u'canonical_url': u'',
154 u'analytics_id': u'',
156 u'display_version': True,
157 u'prev_next_buttons_location': u'bottom',
158 u'style_external_links': False,
160 u'collapse_navigation': True,
161 u'sticky_navigation': True,
162 u'navigation_depth': 3,
163 u'includehidden': True,
164 u'titles_only': False
167 # Add any paths that contain custom static files (such as style sheets) here,
168 # relative to this directory. They are copied after the builtin static files,
169 # so a file named "default.css" will overwrite the builtin "default.css".
170 html_theme_path = [u'env/lib/python2.7/site-packages/sphinx_rtd_theme']
172 # html_static_path = ['_build/_static']
173 html_static_path = [u'_tmp/src/_static']
177 # overrides for wide tables in RTD theme
178 u'_static/theme_overrides.css'
182 # If false, no module index is generated.
183 html_domain_indices = True
185 # If false, no index is generated.
186 html_use_index = True
188 # If true, the index is split into individual pages for each letter.
189 html_split_index = False
191 # -- Options for LaTeX output ---------------------------------------------
193 latex_engine = u'pdflatex'
196 # The paper size ('letterpaper' or 'a4paper').
198 u'papersize': u'a4paper',
200 # The font size ('10pt', '11pt' or '12pt').
202 #'pointsize': '10pt',
204 # Additional stuff for the LaTeX preamble.
207 \usepackage{pdfpages}
210 \usepackage[defaultsans]{lato}
211 \usepackage{inconsolata}
212 \usepackage{csvsimple}
213 \usepackage{longtable}
214 \usepackage{booktabs}
217 # Latex figure (float) alignment
219 u'figure_align': u'H',
224 \renewcommand{\familydefault}{\sfdefault}
229 u'extraclassoptions': u'openany',
231 TitleColor={RGB}{225,38,40},
232 InnerLinkColor={RGB}{62,62,63},
233 OuterLinkColor={RGB}{225,38,40},
240 # Grouping the document tree into LaTeX files. List of tuples
241 # (source start file, target name, title,
242 # author, documentclass [howto, manual, or own class]).
244 (master_doc, u'csit.tex', u'CSIT REPORT', u'', u'manual'),
247 # The name of an image file (relative to this directory) to place at the top of
250 # latex_logo = 'fdio.pdf'
252 # For "manual" documents, if this is true, then toplevel headings are parts,
255 # latex_use_parts = True
257 # If true, show page references after internal links.
259 latex_show_pagerefs = True
261 # If true, show URL addresses after external links.
263 latex_show_urls = u'footnote'
265 # Documents to append as an appendix to all manuals.
267 # latex_appendices = []
269 # It false, will not define \strong, \code, itleref, \crossref ... but only
270 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
273 # latex_keep_old_macro_names = True
275 # If false, no module index is generated.
277 # latex_domain_indices = True