8236cab605238c037e288670cc257a013757cb56
[csit.git] / resources / tools / presentation / conf.py
1 # -*- coding: utf-8 -*-
2 #
3 # CSIT report documentation build configuration file
4 #
5 # This file is execfile()d with the current directory set to its
6 # containing dir.
7 #
8 # Note that not all possible configuration values are present in this
9 # autogenerated file.
10 #
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
13
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.
17
18
19 import os
20 import sys
21
22 sys.path.insert(0, os.path.abspath('.'))
23
24 # -- General configuration ------------------------------------------------
25
26 # If your documentation needs a minimal Sphinx version, state it here.
27 #
28 # needs_sphinx = '1.0'
29
30 # Add any Sphinx extension module names here, as strings. They can be
31 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32 # ones.
33 extensions = ['sphinxcontrib.programoutput',
34               'sphinx.ext.ifconfig']
35
36 # Add any paths that contain templates here, relative to this directory.
37 templates_path = ['_templates']
38
39 # The suffix(es) of source file names.
40 # You can specify multiple suffix as a list of string:
41 #
42 source_suffix = ['.rst', '.md']
43
44 # The master toctree document.
45 master_doc = 'index'
46
47 # General information about the project.
48 project = u'FD.io CSIT-18.07'
49 copyright = u'2018, FD.io'
50 author = u'FD.io CSIT'
51
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
54 # built documents.
55 #
56 # The short X.Y version.
57 # version = u''
58 # The full version, including alpha/beta/rc tags.
59 # release = u''
60
61 rst_epilog = """
62 .. |release-1| replace:: {prev_release}
63 .. |srelease| replace:: {srelease}
64 .. |csit-release| replace:: CSIT-{csitrelease}
65 .. |csit-release-1| replace:: CSIT-{csit_prev_release}
66 .. |vpp-release| replace:: VPP-{vpprelease} release
67 .. |vpp-release-1| replace:: VPP-{vpp_prev_release} release
68 .. |dpdk-release| replace:: DPDK {dpdkrelease}
69 .. |trex-release| replace:: TRex {trex_version}
70 .. |virl-image-ubuntu| replace:: {csit_ubuntu_ver}
71 .. |virl-image-centos| replace:: {csit_centos_ver}
72
73 .. _pdf version of this report: https://docs.fd.io/csit/{release}/report/_static/archive/csit_{release}.pdf
74 .. _tag documentation rst file: https://git.fd.io/csit/tree/docs/tag_documentation.rst?h={release}
75 .. _TRex intallation: 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 .. _VIRL topologies directory: https://git.fd.io/csit/tree/resources/tools/virl/topologies/?h={release}
78 .. _VIRL ubuntu images lists: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/ubuntu/lists/?h={release}
79 .. _VIRL centos images lists: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/centos/lists/?h={release}
80 .. _VIRL nested: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/nested/?h={release}
81 .. _CSIT Honeycomb Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.func.honeycomb.html
82 .. _CSIT Honeycomb Performance Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.perf.honeycomb.html
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 NSH_SFC Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.nsh_sfc.func.html
87 .. _VPP test framework documentation: https://docs.fd.io/vpp/{vpprelease}/vpp_make_test/html/
88 .. _FD.io test executor dpdk performance job 3n-hsw: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-verify-{srelease}-3n-hsw
89 .. _FD.io test executor dpdk performance job 3n-skx: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-verify-{srelease}-3n-skx
90 .. _FD.io test executor dpdk performance job 2n-skx: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-verify-{srelease}-2n-skx
91 .. _FD.io test executor vpp performance job 3n-hsw: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-1807-3n-hsw
92 .. _FD.io test executor vpp performance job 3n-skx: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-1807-3n-skx
93 .. _FD.io test executor vpp performance job 2n-skx: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-1807-2n-skx
94 .. _FD.io test executor ligato performance jobs: https://jenkins.fd.io/job/csit-ligato-perf-{srelease}-all
95 .. _FD.io test executor vpp functional jobs using Ubuntu: https://jenkins.fd.io/view/csit/job/csit-vpp-functional-{srelease}-ubuntu1604-virl
96 .. _FD.io test executor vpp functional jobs using CentOs: https://jenkins.fd.io/view/csit/job/csit-vpp-functional-{srelease}-centos7-virl
97 .. _FD.io test executor Honeycomb functional jobs: https://jenkins.fd.io/view/csit/job/hc2vpp-csit-integration-{srelease}-ubuntu1604
98 .. _FD.io test executor NSH_SFC functional jobs: https://jenkins.fd.io/view/csit/job/csit-nsh_sfc-verify-func-{srelease}-ubuntu1604-virl
99 .. _FD.io VPP compile job: https://jenkins.fd.io/view/vpp/job/vpp-merge-{srelease}-ubuntu1604/
100 .. _FD.io DPDK compile job: https://jenkins.fd.io/view/deb-dpdk/job/deb_dpdk-merge-{sdpdkrelease}-ubuntu1604/
101 .. _CSIT Testbed Setup: https://git.fd.io/csit/tree/resources/tools/testbed-setup/README.md?h={release}
102 .. _K8s configuration files: https://github.com/FDio/csit/tree/{release}/resources/templates/kubernetes
103 """.format(release='rls1807',
104            prev_release='rls1804',
105            srelease='1807',
106            csitrelease='18.07',
107            csit_prev_release='18.04',
108            vpprelease='18.07',
109            vpp_prev_release='18.04',
110            dpdkrelease='18.05',
111            sdpdkrelease='1805',
112            trex_version='v2.35',
113            csit_ubuntu_ver='csit-ubuntu-16.04.1_2018-03-07_2.1',
114            csit_centos_ver='csit-centos-7.4-1711_2018-03-20_1.9')
115
116 # The language for content autogenerated by Sphinx. Refer to documentation
117 # for a list of supported languages.
118 #
119 # This is also used if you do content translation via gettext catalogs.
120 # Usually you set "language" from the command line for these cases.
121 language = 'en'
122
123 # List of patterns, relative to source directory, that match files and
124 # directories to ignore when looking for source files.
125 # This patterns also effect to html_static_path and html_extra_path
126 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
127
128 # The name of the Pygments (syntax highlighting) style to use.
129 pygments_style = 'sphinx'
130
131 # If true, `todo` and `todoList` produce output, else they produce nothing.
132 todo_include_todos = False
133
134 # -- Options for HTML output ----------------------------------------------
135
136 # The theme to use for HTML and HTML Help pages.  See the documentation for
137 # a list of builtin themes.
138 #
139 html_theme = 'sphinx_rtd_theme'
140
141 # Theme options are theme-specific and customize the look and feel of a theme
142 # further.  For a list of options available for each theme, see the
143 # documentation.
144 #
145 html_theme_options = {
146     'canonical_url': '',
147     'analytics_id': '',
148     'logo_only': False,
149     'display_version': True,
150     'prev_next_buttons_location': 'bottom',
151     'style_external_links': False,
152     # Toc options
153     'collapse_navigation': True,
154     'sticky_navigation': True,
155     'navigation_depth': 3,
156     'includehidden': True,
157     'titles_only': False
158 }
159
160 # Add any paths that contain custom static files (such as style sheets) here,
161 # relative to this directory. They are copied after the builtin static files,
162 # so a file named "default.css" will overwrite the builtin "default.css".
163 html_theme_path = ['env/lib/python2.7/site-packages/sphinx_rtd_theme']
164
165 # html_static_path = ['_build/_static']
166 html_static_path = ['_tmp/src/_static']
167
168 html_context = {
169     'css_files': [
170         '_static/theme_overrides.css',  # overrides for wide tables in RTD theme
171         ],
172     }
173
174 # If false, no module index is generated.
175 html_domain_indices = True
176
177 # If false, no index is generated.
178 html_use_index = True
179
180 # If true, the index is split into individual pages for each letter.
181 html_split_index = False
182
183 # -- Options for LaTeX output ---------------------------------------------
184
185 latex_engine = 'pdflatex'
186
187 latex_elements = {
188      # The paper size ('letterpaper' or 'a4paper').
189      #
190      'papersize': 'a4paper',
191
192      # The font size ('10pt', '11pt' or '12pt').
193      #
194      #'pointsize': '10pt',
195
196      # Additional stuff for the LaTeX preamble.
197      #
198      'preamble': r'''
199          \usepackage{pdfpages}
200          \usepackage{svg}
201          \usepackage{charter}
202          \usepackage[defaultsans]{lato}
203          \usepackage{inconsolata}
204          \usepackage{csvsimple}
205          \usepackage{longtable}
206          \usepackage{booktabs}
207      ''',
208
209      # Latex figure (float) alignment
210      #
211      'figure_align': 'H',
212
213      # Latex font setup
214      #
215      'fontpkg': r'''
216          \renewcommand{\familydefault}{\sfdefault}
217      ''',
218
219      # Latex other setup
220      #
221      'extraclassoptions': 'openany',
222      'sphinxsetup': r'''
223          TitleColor={RGB}{225,38,40},
224          InnerLinkColor={RGB}{62,62,63},
225          OuterLinkColor={RGB}{225,38,40},
226          shadowsep=0pt,
227          shadowsize=0pt,
228          shadowrule=0pt
229      '''
230 }
231
232 # Grouping the document tree into LaTeX files. List of tuples
233 # (source start file, target name, title,
234 #  author, documentclass [howto, manual, or own class]).
235 latex_documents = [
236     (master_doc, 'csit.tex', u'CSIT REPORT',
237      u'', 'manual'),
238 ]
239
240 # The name of an image file (relative to this directory) to place at the top of
241 # the title page.
242 #
243 # latex_logo = 'fdio.pdf'
244
245 # For "manual" documents, if this is true, then toplevel headings are parts,
246 # not chapters.
247 #
248 # latex_use_parts = True
249
250 # If true, show page references after internal links.
251 #
252 latex_show_pagerefs = True
253
254 # If true, show URL addresses after external links.
255 #
256 latex_show_urls = 'footnote'
257
258 # Documents to append as an appendix to all manuals.
259 #
260 # latex_appendices = []
261
262 # It false, will not define \strong, \code,     itleref, \crossref ... but only
263 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
264 # packages.
265 #
266 # latex_keep_old_macro_names = True
267
268 # If false, no module index is generated.
269 #
270 # latex_domain_indices = True

©2016 FD.io a Linux Foundation Collaborative Project. All Rights Reserved.
Linux Foundation is a registered trademark of The Linux Foundation. Linux is a registered trademark of Linus Torvalds.
Please see our privacy policy and terms of use.