58dd56163ad1fbcf2af98603ac07c77049745592
[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'
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 .. |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}
70
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 images lists: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/ubuntu/lists/?h={release}
77 .. _VIRL nested: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/nested/?h={release}
78 .. _CSIT Honeycomb Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.func.honeycomb.html
79 .. _CSIT Honeycomb Performance Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.perf.honeycomb.html
80 .. _CSIT DPDK Performance Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.dpdk.perf.html
81 .. _CSIT VPP Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.func.html
82 .. _CSIT VPP Performance Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.perf.html
83 .. _CSIT NSH_SFC Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.nsh_sfc.func.html
84 .. _VPP test framework documentation: https://docs.fd.io/vpp/{vpprelease}/vpp_make_test/html/
85 .. _FD.io test executor vpp performance jobs: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-{srelease}-all
86 .. _FD.io test executor ligato performance jobs: https://jenkins.fd.io/job/csit-ligato-perf-{srelease}-all
87 .. _FD.io test executor vpp functional jobs: https://jenkins.fd.io/view/csit/job/csit-vpp-functional-{srelease}-ubuntu1604-virl/lastSuccessfulBuild
88 .. _FD.io test executor dpdk performance jobs: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-{srelease}-all
89 .. _FD.io test executor Honeycomb functional jobs: https://jenkins.fd.io/view/csit/job/hc2vpp-csit-integration-{srelease}-ubuntu1604/lastSuccessfulBuild
90 .. _FD.io test executor honeycomb performance jobs: https://jenkins.fd.io/view/hc2vpp/job/hc2vpp-csit-perf-master-ubuntu1604/lastSuccessfulBuild
91 .. _FD.io test executor NSH_SFC functional jobs: https://jenkins.fd.io/view/csit/job/csit-nsh_sfc-verify-func-{srelease}-ubuntu1604-virl/lastSuccessfulBuild
92 .. _FD.io VPP compile job: https://jenkins.fd.io/view/vpp/job/vpp-merge-{srelease}-ubuntu1604/
93 .. _FD.io DPDK compile job: https://jenkins.fd.io/view/deb-dpdk/job/deb_dpdk-merge-{sdpdkrelease}-ubuntu1604/
94 .. _CSIT Testbed Setup: https://git.fd.io/csit/tree/resources/tools/testbed-setup/README.md?h={release}
95 """.format(release='rls1804',
96            prev_release='rls1801',
97            srelease='1804',
98            vpprelease='18.04',
99            vpp_prev_release='18.01',
100            dpdkrelease='18.02',
101            sdpdkrelease='1802',
102            trex_version='v2.35',
103            csit_ubuntu_ver='csit-ubuntu-16.04.1_2018-03-07_2.1',
104            csit_centos_ver='csit-centos-7.4-1711_2018-03-20_1.9')
105
106 # The language for content autogenerated by Sphinx. Refer to documentation
107 # for a list of supported languages.
108 #
109 # This is also used if you do content translation via gettext catalogs.
110 # Usually you set "language" from the command line for these cases.
111 language = 'en'
112
113 # List of patterns, relative to source directory, that match files and
114 # directories to ignore when looking for source files.
115 # This patterns also effect to html_static_path and html_extra_path
116 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
117
118 # The name of the Pygments (syntax highlighting) style to use.
119 pygments_style = 'sphinx'
120
121 # If true, `todo` and `todoList` produce output, else they produce nothing.
122 todo_include_todos = False
123
124 # -- Options for HTML output ----------------------------------------------
125
126 # The theme to use for HTML and HTML Help pages.  See the documentation for
127 # a list of builtin themes.
128 #
129 html_theme = 'sphinx_rtd_theme'
130
131 # Theme options are theme-specific and customize the look and feel of a theme
132 # further.  For a list of options available for each theme, see the
133 # documentation.
134 #
135 # html_theme_options = {}
136
137 # Add any paths that contain custom static files (such as style sheets) here,
138 # relative to this directory. They are copied after the builtin static files,
139 # so a file named "default.css" will overwrite the builtin "default.css".
140 html_theme_path = ['env/lib/python2.7/site-packages/sphinx_rtd_theme']
141
142 # html_static_path = ['_build/_static']
143 html_static_path = ['_tmp/src/_static']
144
145 html_context = {
146     'css_files': [
147         '_static/theme_overrides.css',  # overrides for wide tables in RTD theme
148         ],
149     }
150
151 # -- Options for LaTeX output ---------------------------------------------
152
153 latex_engine = 'pdflatex'
154
155 latex_elements = {
156      # The paper size ('letterpaper' or 'a4paper').
157      #
158      'papersize': 'a4paper',
159
160      # The font size ('10pt', '11pt' or '12pt').
161      #
162      #'pointsize': '10pt',
163
164      # Additional stuff for the LaTeX preamble.
165      #
166      'preamble': r'''
167          \usepackage{pdfpages}
168          \usepackage{svg}
169          \usepackage{charter}
170          \usepackage[defaultsans]{lato}
171          \usepackage{inconsolata}
172          \usepackage{csvsimple}
173          \usepackage{longtable}
174          \usepackage{booktabs}
175      ''',
176
177      # Latex figure (float) alignment
178      #
179      'figure_align': 'H',
180
181      # Latex font setup
182      #
183      'fontpkg': r'''
184          \renewcommand{\familydefault}{\sfdefault}
185      ''',
186
187      # Latex other setup
188      #
189      'extraclassoptions': 'openany',
190      'sphinxsetup': r'''
191          TitleColor={RGB}{225,38,40},
192          InnerLinkColor={RGB}{62,62,63},
193          OuterLinkColor={RGB}{225,38,40},
194          shadowsep=0pt,
195          shadowsize=0pt,
196          shadowrule=0pt
197      '''
198 }
199
200 # Grouping the document tree into LaTeX files. List of tuples
201 # (source start file, target name, title,
202 #  author, documentclass [howto, manual, or own class]).
203 latex_documents = [
204     (master_doc, 'csit.tex', u'CSIT REPORT',
205      u'', 'manual'),
206 ]
207
208 # The name of an image file (relative to this directory) to place at the top of
209 # the title page.
210 #
211 # latex_logo = 'fdio.pdf'
212
213 # For "manual" documents, if this is true, then toplevel headings are parts,
214 # not chapters.
215 #
216 # latex_use_parts = True
217
218 # If true, show page references after internal links.
219 #
220 latex_show_pagerefs = True
221
222 # If true, show URL addresses after external links.
223 #
224 latex_show_urls = 'footnote'
225
226 # Documents to append as an appendix to all manuals.
227 #
228 # latex_appendices = []
229
230 # It false, will not define \strong, \code,     itleref, \crossref ... but only
231 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
232 # packages.
233 #
234 # latex_keep_old_macro_names = True
235
236 # If false, no module index is generated.
237 #
238 # 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.