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