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 sys.path.insert(0, os.path.abspath('.'))
24 # -- General configuration ------------------------------------------------
26 # If your documentation needs a minimal Sphinx version, state it here.
28 # needs_sphinx = '1.0'
30 # Add any Sphinx extension module names here, as strings. They can be
31 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
33 extensions = ['sphinxcontrib.programoutput',
34 'sphinx.ext.ifconfig']
36 # Add any paths that contain templates here, relative to this directory.
37 templates_path = ['_templates']
39 # The suffix(es) of source file names.
40 # You can specify multiple suffix as a list of string:
42 source_suffix = ['.rst', '.md']
44 # The master toctree document.
47 # General information about the project.
48 project = u'FD.io CSIT rls1807 Report'
49 copyright = u'2018, FD.io'
50 author = u'FD.io CSIT'
52 # The version info for the project you're documenting, acts as replacement for
53 # |version| and |release|, also used in various other places throughout the
56 # The short X.Y version.
58 # The full version, including alpha/beta/rc tags.
62 .. |release-1| replace:: {prev_release}
63 .. |srelease| replace:: {srelease}
64 .. |vpp-release| replace:: VPP-{vpprelease} release
65 .. |vpp-release-1| replace:: VPP-{vpp_prev_release} release
66 .. |dpdk-release| replace:: DPDK {dpdkrelease}
67 .. |trex-release| replace:: TRex {trex_version}
68 .. |virl-image-ubuntu| replace:: {csit_ubuntu_ver}
69 .. |virl-image-centos| replace:: {csit_centos_ver}
71 .. _pdf version of this report: https://docs.fd.io/csit/{release}/report/_static/archive/csit_{release}.pdf
72 .. _tag documentation rst file: https://git.fd.io/csit/tree/docs/tag_documentation.rst?h={release}
73 .. _TRex intallation: https://git.fd.io/csit/tree/resources/tools/trex/trex_installer.sh?h={release}
74 .. _TRex driver: https://git.fd.io/csit/tree/resources/tools/trex/trex_stateless_profile.py?h={release}
75 .. _VIRL topologies directory: https://git.fd.io/csit/tree/resources/tools/virl/topologies/?h={release}
76 .. _VIRL ubuntu images lists: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/ubuntu/lists/?h={release}
77 .. _VIRL centos images lists: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/centos/lists/?h={release}
78 .. _VIRL nested: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/nested/?h={release}
79 .. _CSIT Honeycomb Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.func.honeycomb.html
80 .. _CSIT Honeycomb Performance Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.perf.honeycomb.html
81 .. _CSIT DPDK Performance Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.dpdk.perf.html
82 .. _CSIT VPP Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.func.html
83 .. _CSIT VPP Performance Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.perf.html
84 .. _CSIT NSH_SFC Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.nsh_sfc.func.html
85 .. _VPP test framework documentation: https://docs.fd.io/vpp/{vpprelease}/vpp_make_test/html/
86 .. _FD.io test executor vpp performance jobs: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-{srelease}-all
87 .. _FD.io test executor ligato performance jobs: https://jenkins.fd.io/job/csit-ligato-perf-{srelease}-all
88 .. _FD.io test executor vpp functional jobs: https://jenkins.fd.io/view/csit/job/csit-vpp-functional-{srelease}-ubuntu1604-virl/lastSuccessfulBuild
89 .. _FD.io test executor dpdk performance jobs: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-{srelease}-all
90 .. _FD.io test executor Honeycomb functional jobs: https://jenkins.fd.io/view/csit/job/hc2vpp-csit-integration-{srelease}-ubuntu1604/lastSuccessfulBuild
91 .. _FD.io test executor honeycomb performance jobs: https://jenkins.fd.io/view/hc2vpp/job/hc2vpp-csit-perf-master-ubuntu1604/lastSuccessfulBuild
92 .. _FD.io test executor NSH_SFC functional jobs: https://jenkins.fd.io/view/csit/job/csit-nsh_sfc-verify-func-{srelease}-ubuntu1604-virl/lastSuccessfulBuild
93 .. _FD.io VPP compile job: https://jenkins.fd.io/view/vpp/job/vpp-merge-{srelease}-ubuntu1604/
94 .. _FD.io DPDK compile job: https://jenkins.fd.io/view/deb-dpdk/job/deb_dpdk-merge-{sdpdkrelease}-ubuntu1604/
95 .. _CSIT Testbed Setup: https://git.fd.io/csit/tree/resources/tools/testbed-setup/README.md?h={release}
96 .. _K8s configuration files: https://github.com/FDio/csit/tree/{release}/resources/templates/kubernetes
97 """.format(release='rls1807',
98 prev_release='rls1804',
101 vpp_prev_release='18.04',
104 trex_version='v2.35',
105 csit_ubuntu_ver='csit-ubuntu-16.04.1_2018-03-07_2.1',
106 csit_centos_ver='csit-centos-7.4-1711_2018-03-20_1.9')
108 # The language for content autogenerated by Sphinx. Refer to documentation
109 # for a list of supported languages.
111 # This is also used if you do content translation via gettext catalogs.
112 # Usually you set "language" from the command line for these cases.
115 # List of patterns, relative to source directory, that match files and
116 # directories to ignore when looking for source files.
117 # This patterns also effect to html_static_path and html_extra_path
118 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
120 # The name of the Pygments (syntax highlighting) style to use.
121 pygments_style = 'sphinx'
123 # If true, `todo` and `todoList` produce output, else they produce nothing.
124 todo_include_todos = False
126 # -- Options for HTML output ----------------------------------------------
128 # The theme to use for HTML and HTML Help pages. See the documentation for
129 # a list of builtin themes.
131 html_theme = 'sphinx_rtd_theme'
133 # Theme options are theme-specific and customize the look and feel of a theme
134 # further. For a list of options available for each theme, see the
137 html_theme_options = {
141 'display_version': True,
142 'prev_next_buttons_location': 'bottom',
143 'style_external_links': False,
145 'collapse_navigation': True,
146 'sticky_navigation': True,
147 'navigation_depth': 3,
148 'includehidden': True,
152 # Add any paths that contain custom static files (such as style sheets) here,
153 # relative to this directory. They are copied after the builtin static files,
154 # so a file named "default.css" will overwrite the builtin "default.css".
155 html_theme_path = ['env/lib/python2.7/site-packages/sphinx_rtd_theme']
157 # html_static_path = ['_build/_static']
158 html_static_path = ['_tmp/src/_static']
162 '_static/theme_overrides.css', # overrides for wide tables in RTD theme
166 # If false, no module index is generated.
167 html_domain_indices = True
169 # If false, no index is generated.
170 html_use_index = True
172 # If true, the index is split into individual pages for each letter.
173 html_split_index = False
175 # -- Options for LaTeX output ---------------------------------------------
177 latex_engine = 'pdflatex'
180 # The paper size ('letterpaper' or 'a4paper').
182 'papersize': 'a4paper',
184 # The font size ('10pt', '11pt' or '12pt').
186 #'pointsize': '10pt',
188 # Additional stuff for the LaTeX preamble.
191 \usepackage{pdfpages}
194 \usepackage[defaultsans]{lato}
195 \usepackage{inconsolata}
196 \usepackage{csvsimple}
197 \usepackage{longtable}
198 \usepackage{booktabs}
201 # Latex figure (float) alignment
208 \renewcommand{\familydefault}{\sfdefault}
213 'extraclassoptions': 'openany',
215 TitleColor={RGB}{225,38,40},
216 InnerLinkColor={RGB}{62,62,63},
217 OuterLinkColor={RGB}{225,38,40},
224 # Grouping the document tree into LaTeX files. List of tuples
225 # (source start file, target name, title,
226 # author, documentclass [howto, manual, or own class]).
228 (master_doc, 'csit.tex', u'CSIT REPORT',
232 # The name of an image file (relative to this directory) to place at the top of
235 # latex_logo = 'fdio.pdf'
237 # For "manual" documents, if this is true, then toplevel headings are parts,
240 # latex_use_parts = True
242 # If true, show page references after internal links.
244 latex_show_pagerefs = True
246 # If true, show URL addresses after external links.
248 latex_show_urls = 'footnote'
250 # Documents to append as an appendix to all manuals.
252 # latex_appendices = []
254 # It false, will not define \strong, \code, itleref, \crossref ... but only
255 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
258 # latex_keep_old_macro_names = True
260 # If false, no module index is generated.
262 # latex_domain_indices = True