1 # -*- coding: utf-8 -*-
3 # CSIT 17.01 report documentation build configuration file, created by
4 # sphinx-quickstart on Sun Jan 15 09:49:36 2017.
6 # This file is execfile()d with the current directory set to its
9 # Note that not all possible configuration values are present in this
12 # All configuration values have a default; values that are commented out
13 # serve to show the default.
15 # If extensions (or modules to document with autodoc) are in another directory,
16 # add these directories to sys.path here. If the directory is relative to the
17 # 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 filenames.
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'
49 copyright = u'2017, 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:: rls1704
63 .. |vpp-release| replace:: VPP-17.10 release
64 .. |vpp-release-1| replace:: VPP-17.04 release
65 .. |dpdk-release| replace:: DPDK 17.05
66 .. |trex-release| replace:: TRex v2.25
67 .. |virl-image-ubuntu| replace:: ubuntu-16.04.1_2017-02-23_1.8
68 .. |virl-image-centos| replace:: centos-7.3-1611_2017-02-23_1.4
70 .. _tag documentation rst file: https://git.fd.io/csit/tree/docs/tag_documentation.rst?h=rls1710
71 .. _TRex intallation: https://git.fd.io/csit/tree/resources/tools/trex/trex_installer.sh?h=rls17010
72 .. _TRex driver: https://git.fd.io/csit/tree/resources/tools/trex/trex_stateless_profile.py?h=rls1710
73 .. _VIRL topologies directory: https://git.fd.io/csit/tree/resources/tools/virl/topologies/?h=rls1710
74 .. _VIRL images lists: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/ubuntu/lists/?h=rls1710
75 .. _VIRL nested: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/nested/?h=rls1710
76 .. _CSIT Honeycomb Functional Tests Documentation: https://docs.fd.io/csit/rls1710/doc/tests.vpp.func.honeycomb.html
77 .. _CSIT Honeycomb Performance Tests Documentation: https://docs.fd.io/csit/rls1710/doc/tests.vpp.perf.honeycomb.html
78 .. _CSIT DPDK Performance Tests Documentation: https://docs.fd.io/csit/rls1710/doc/tests.dpdk.perf.html
79 .. _CSIT VPP Functional Tests Documentation: https://docs.fd.io/csit/rls1710/doc/tests.vpp.func.html
80 .. _CSIT VPP Performance Tests Documentation: https://docs.fd.io/csit/rls1710/doc/tests.vpp.perf.html
81 .. _CSIT NSH_SFC Functional Tests Documentation: https://docs.fd.io/csit/rls1710/doc/tests.nsh_sfc.func.html
82 .. _VPP test framework documentation: https://docs.fd.io/vpp/17.10/vpp_make_test/html/
83 .. _FD.io test executor vpp performance jobs: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-1710-all
84 .. _FD.io test executor vpp functional jobs: https://jenkins.fd.io/view/csit/job/csit-vpp-functional-1710-ubuntu1604-virl/lastSuccessfulBuild
85 .. _FD.io test executor dpdk performance jobs: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-1710-all
86 .. _FD.io test executor Honeycomb functional jobs: https://jenkins.fd.io/view/csit/job/hc2vpp-csit-integration-1710-ubuntu1604/lastSuccessfulBuild
87 .. _FD.io test executor honeycomb performance jobs: https://jenkins.fd.io/view/hc2vpp/job/hc2vpp-csit-perf-master-ubuntu1604/lastSuccessfulBuild
88 .. _FD.io test executor NSH_SFC functional jobs: https://jenkins.fd.io/view/csit/job/csit-nsh_sfc-verify-func-1710-ubuntu1604-virl/lastSuccessfulBuild
89 .. _FD.io VPP compile job: https://jenkins.fd.io/view/vpp/job/vpp-merge-1710-ubuntu1604/
90 .. _CSIT Testbed Setup: https://git.fd.io/csit/tree/resources/tools/testbed-setup/README.md?h=rls1710
93 # The language for content autogenerated by Sphinx. Refer to documentation
94 # for a list of supported languages.
96 # This is also used if you do content translation via gettext catalogs.
97 # Usually you set "language" from the command line for these cases.
100 # List of patterns, relative to source directory, that match files and
101 # directories to ignore when looking for source files.
102 # This patterns also effect to html_static_path and html_extra_path
103 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
105 # The name of the Pygments (syntax highlighting) style to use.
106 pygments_style = 'sphinx'
108 # If true, `todo` and `todoList` produce output, else they produce nothing.
109 todo_include_todos = False
111 # -- Options for HTML output ----------------------------------------------
113 # The theme to use for HTML and HTML Help pages. See the documentation for
114 # a list of builtin themes.
116 html_theme = 'sphinx_rtd_theme'
118 # Theme options are theme-specific and customize the look and feel of a theme
119 # further. For a list of options available for each theme, see the
122 # html_theme_options = {}
124 # Add any paths that contain custom static files (such as style sheets) here,
125 # relative to this directory. They are copied after the builtin static files,
126 # so a file named "default.css" will overwrite the builtin "default.css".
127 html_theme_path = ['env/lib/python2.7/site-packages/sphinx_rtd_theme']
129 # html_static_path = ['_build/_static']
130 html_static_path = ['_tmp/src/_static']
134 '_static/theme_overrides.css', # overrides for wide tables in RTD theme
138 # -- Options for LaTeX output ---------------------------------------------
140 latex_engine = 'pdflatex'
143 # The paper size ('letterpaper' or 'a4paper').
145 'papersize': 'a4paper',
147 # The font size ('10pt', '11pt' or '12pt').
149 #'pointsize': '10pt',
151 # Additional stuff for the LaTeX preamble.
154 \usepackage{pdfpages}
157 \usepackage[defaultsans]{lato}
158 \usepackage{inconsolata}
159 \usepackage{csvsimple}
160 \usepackage{longtable}
161 \usepackage{booktabs}
164 # Latex figure (float) alignment
171 \renewcommand{\familydefault}{\sfdefault}
176 'extraclassoptions': 'openany',
178 TitleColor={RGB}{225,38,40},
179 InnerLinkColor={RGB}{62,62,63},
180 OuterLinkColor={RGB}{225,38,40},
187 # Grouping the document tree into LaTeX files. List of tuples
188 # (source start file, target name, title,
189 # author, documentclass [howto, manual, or own class]).
191 (master_doc, 'csit.tex', u'CSIT REPORT',
195 # The name of an image file (relative to this directory) to place at the top of
198 # latex_logo = 'fdio.pdf'
200 # For "manual" documents, if this is true, then toplevel headings are parts,
203 # latex_use_parts = True
205 # If true, show page references after internal links.
207 latex_show_pagerefs = True
209 # If true, show URL addresses after external links.
211 latex_show_urls = 'footnote'
213 # Documents to append as an appendix to all manuals.
215 # latex_appendices = []
217 # It false, will not define \strong, \code, itleref, \crossref ... but only
218 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
221 # latex_keep_old_macro_names = True
223 # If false, no module index is generated.
225 # latex_domain_indices = True