Report: Hoststack graphs
[csit.git] / resources / tools / doc_gen / src / conf.py
1 # -*- coding: utf-8 -*-
2 #
3 # CSIT documentation build configuration file, created by
4 # sphinx-quickstart on Tue Nov  8 10:19:40 2016.
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(u"."))
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 = [
34     u"sphinx.ext.autodoc",
35     u"sphinx.ext.doctest",
36     u"sphinxcontrib_robotdoc"
37 ]
38
39 # Add any paths that contain templates here, relative to this directory.
40 templates_path = [u"_templates"]
41
42 # The suffix(es) of source file names.
43 # You can specify multiple suffix as a list of string:
44 #
45 # source_suffix = [u".rst", u".md"]
46 source_suffix = u".rst"
47
48 # The encoding of source files.
49 #
50 # source_encoding = 'utf-8-sig'
51
52 # The master toctree document.
53 master_doc = u"index"
54
55 # General information about the project.
56 project = u"CSIT"
57 copyright = u"2018, FD.io"
58 author = u"CSIT"
59
60 # The version info for the project you're documenting, acts as replacement for
61 # |version| and |release|, also used in various other places throughout the
62 # built documents.
63 #
64 # The short X.Y version.
65 # version = u'master'
66 # The full version, including alpha/beta/rc tags.
67 # release = u'master'
68
69 # The language for content autogenerated by Sphinx. Refer to documentation
70 # for a list of supported languages.
71 #
72 # This is also used if you do content translation via gettext catalogs.
73 # Usually you set "language" from the command line for these cases.
74 language = None
75
76 # There are two options for replacing |today|: either, you set today to some
77 # non-false value, then it is used:
78 #
79 # today = ''
80 #
81 # Else, today_fmt is used as the format for a strftime call.
82 #
83 # today_fmt = '%B %d, %Y'
84
85 # List of patterns, relative to source directory, that match files and
86 # directories to ignore when looking for source files.
87 # This patterns also effect to html_static_path and html_extra_path
88 exclude_patterns = [u"_build", u"Thumbs.db", u".DS_Store"]
89
90 # The reST default role (used for this markup: `text`) to use for all
91 # documents.
92 #
93 # default_role = None
94
95 # If true, '()' will be appended to :func: etc. cross-reference text.
96 #
97 # add_function_parentheses = True
98
99 # If true, the current module name will be prepended to all description
100 # unit titles (such as .. function::).
101 #
102 # add_module_names = True
103
104 # If true, sectionauthor and moduleauthor directives will be shown in the
105 # output. They are ignored by default.
106 #
107 # show_authors = False
108
109 # The name of the Pygments (syntax highlighting) style to use.
110 pygments_style = u"sphinx"
111
112 # A list of ignored prefixes for module index sorting.
113 # modindex_common_prefix = []
114
115 # If true, keep warnings as "system message" paragraphs in the built documents.
116 # keep_warnings = False
117
118 # If true, `todo` and `todoList` produce output, else they produce nothing.
119 todo_include_todos = False
120
121
122 # -- Options for HTML output ----------------------------------------------
123
124 # The theme to use for HTML and HTML Help pages.  See the documentation for
125 # a list of builtin themes.
126 #
127 # html_theme =u"alabaster"
128 html_theme = u"sphinx_rtd_theme"
129
130 # Theme options are theme-specific and customize the look and feel of a theme
131 # further.  For a list of options available for each theme, see the
132 # documentation.
133 #
134 # html_theme_options = {}
135
136 # Add any paths that contain custom themes here, relative to this directory.
137 html_theme_path = [u"env/lib/python2.7/site-packages/sphinx_rtd_theme"]
138
139 # The name for this set of Sphinx documents.
140 # "<project> v<release> documentation" by default.
141 #
142 html_title = u"CSIT Documentation"
143
144 # A shorter title for the navigation bar.  Default is the same as html_title.
145 #
146 html_short_title = u"CSIT"
147
148 # The name of an image file (relative to this directory) to place at the top
149 # of the sidebar.
150 #
151 html_logo = u"fdio_logo.png"
152
153 # The name of an image file (relative to this directory) to use as a favicon of
154 # the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
155 # pixels large.
156 #
157 # html_favicon = None
158
159 # Add any paths that contain custom static files (such as style sheets) here,
160 # relative to this directory. They are copied after the builtin static files,
161 # so a file named "default.css" will overwrite the builtin "default.css".
162 html_static_path = [u"_static"]
163
164 # Add any extra paths that contain custom files (such as robots.txt or
165 # .htaccess) here, relative to this directory. These files are copied
166 # directly to the root of the documentation.
167 #
168 # html_extra_path = []
169
170 # If not None, a 'Last updated on:' timestamp is inserted at every page
171 # bottom, using the given strftime format.
172 # The empty string is equivalent to '%b %d, %Y'.
173 #
174 # html_last_updated_fmt = None
175
176 # If true, SmartyPants will be used to convert quotes and dashes to
177 # typographically correct entities.
178 #
179 # html_use_smartypants = True
180
181 # Custom sidebar templates, maps document names to template names.
182 #
183 # html_sidebars = {
184 #
185 # }
186
187 # Additional templates that should be rendered to pages, maps page names to
188 # template names.
189 #
190 # html_additional_pages = {}
191
192 # If false, no module index is generated.
193 #
194 # html_domain_indices = True
195
196 # If false, no index is generated.
197 #
198 # html_use_index = True
199
200 # If true, the index is split into individual pages for each letter.
201 #
202 html_split_index = False
203
204 # If true, links to the reST sources are added to the pages.
205 #
206 html_show_sourcelink = True
207
208 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
209 #
210 # html_show_sphinx = True
211
212 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
213 #
214 # html_show_copyright = True
215
216 # If true, an OpenSearch description file will be output, and all pages will
217 # contain a <link> tag referring to it.  The value of this option must be the
218 # base URL from which the finished HTML is served.
219 #
220 # html_use_opensearch = ''
221
222 # This is the file name suffix for HTML files (e.g. ".xhtml").
223 # html_file_suffix = None
224
225 # Language to be used for generating the HTML full-text search index.
226 # Sphinx supports the following languages:
227 #   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
228 #   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
229 #
230 # html_search_language = 'en'
231
232 # A dictionary with options for the search language support, empty by default.
233 # 'ja' uses this config value.
234 # 'zh' user can custom change `jieba` dictionary path.
235 #
236 # html_search_options = {'type': 'default'}
237
238 # The name of a javascript file (relative to the configuration directory) that
239 # implements a search results scorer. If empty, the default will be used.
240 #
241 # html_search_scorer = 'scorer.js'
242
243 # Output file base name for HTML help builder.
244 htmlhelp_basename = u"csitdoc"
245
246 # -- Options for LaTeX output ---------------------------------------------
247
248 latex_elements = {
249      # The paper size ('letterpaper' or 'a4paper').
250      #
251      # 'papersize': 'letterpaper',
252
253      # The font size ('10pt', '11pt' or '12pt').
254      #
255      # 'pointsize': '10pt',
256
257      # Additional stuff for the LaTeX preamble.
258      #
259      # 'preamble': '',
260
261      # Latex figure (float) alignment
262      #
263      # 'figure_align': 'htbp',
264 }
265
266 # Grouping the document tree into LaTeX files. List of tuples
267 # (source start file, target name, title,
268 #  author, documentclass [howto, manual, or own class]).
269 latex_documents = [
270     (master_doc, u"CSIT.tex", u"CSIT Documentation", u"CSIT", u"manual"),
271 ]
272
273 # The name of an image file (relative to this directory) to place at the top of
274 # the title page.
275 #
276 # latex_logo = None
277
278 # For "manual" documents, if this is true, then toplevel headings are parts,
279 # not chapters.
280 #
281 # latex_use_parts = False
282
283 # If true, show page references after internal links.
284 #
285 # latex_show_pagerefs = False
286
287 # If true, show URL addresses after external links.
288 #
289 # latex_show_urls = False
290
291 # Documents to append as an appendix to all manuals.
292 #
293 # latex_appendices = []
294
295 # It false, will not define \strong, \code,     itleref, \crossref ... but only
296 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
297 # packages.
298 #
299 # latex_keep_old_macro_names = True
300
301 # If false, no module index is generated.
302 #
303 # latex_domain_indices = True
304
305
306 # -- Options for manual page output ---------------------------------------
307
308 # One entry per manual page. List of tuples
309 # (source start file, name, description, authors, manual section).
310 man_pages = [
311     (master_doc, u"CSIT", u"CSIT Documentation", [author], 1)
312 ]
313
314 # If true, show URL addresses after external links.
315 #
316 # man_show_urls = False
317
318
319 # -- Options for Texinfo output -------------------------------------------
320
321 # Grouping the document tree into Texinfo files. List of tuples
322 # (source start file, target name, title, author,
323 #  dir menu entry, description, category)
324 texinfo_documents = [
325     (master_doc, u"CSIT", u"CSIT Documentation",
326      author, u"CSIT", u"One line description of project.",
327      u"Miscellaneous"),
328 ]
329
330 # Documents to append as an appendix to all manuals.
331 #
332 # texinfo_appendices = []
333
334 # If false, no module index is generated.
335 #
336 # texinfo_domain_indices = True
337
338 # How to display URL addresses: 'footnote', 'no', or 'inline'.
339 #
340 # texinfo_show_urls = 'footnote'
341
342 # If true, do not generate a @detailmenu in the "Top" node's menu.
343 #
344 # texinfo_no_detailmenu = False