2 # -*- coding: utf-8 -*-
4 # OpenDaylight Documentation documentation build configuration file, created by
5 # sphinx-quickstart on Mon Mar 28 14:20:08 2016.
7 # This file is execfile()d with the current directory set to its
10 # Note that not all possible configuration values are present in this
13 # All configuration values have a default; values that are commented out
14 # serve to show the default.
18 import sphinx_bootstrap_theme
20 # If extensions (or modules to document with autodoc) are in another directory,
21 # add these directories to sys.path here. If the directory is relative to the
22 # documentation root, use os.path.abspath to make it absolute, like shown here.
23 sys.path.insert(0, os.path.abspath('submodules/spectrometer/server'))
25 # -- General configuration ------------------------------------------------
27 # If your documentation needs a minimal Sphinx version, state it here.
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 = ['sphinx.ext.autodoc','sphinx.ext.graphviz']
35 # Add any paths that contain templates here, relative to this directory.
36 templates_path = ['_templates']
38 # The suffix(es) of source filenames.
39 # You can specify multiple suffix as a list of string:
40 # source_suffix = ['.rst', '.md']
41 source_suffix = '.rst'
43 # The encoding of source files.
44 #source_encoding = 'utf-8-sig'
46 # The master toctree document.
49 # General information about the project.
50 project = 'OpenDaylight Documentation'
51 copyright = '2016, OpenDaylight Project'
52 author = 'OpenDaylight Project'
54 # The version info for the project you're documenting, acts as replacement for
55 # |version| and |release|, also used in various other places throughout the
58 # The short X.Y version.
60 # The full version, including alpha/beta/rc tags.
63 # The language for content autogenerated by Sphinx. Refer to documentation
64 # for a list of supported languages.
66 # This is also used if you do content translation via gettext catalogs.
67 # Usually you set "language" from the command line for these cases.
70 # There are two options for replacing |today|: either, you set today to some
71 # non-false value, then it is used:
73 # Else, today_fmt is used as the format for a strftime call.
74 #today_fmt = '%B %d, %Y'
76 # List of patterns, relative to source directory, that match files and
77 # directories to ignore when looking for source files.
78 # This patterns also effect to html_static_path and html_extra_path
81 # The reST default role (used for this markup: `text`) to use for all
85 # If true, '()' will be appended to :func: etc. cross-reference text.
86 #add_function_parentheses = True
88 # If true, the current module name will be prepended to all description
89 # unit titles (such as .. function::).
90 #add_module_names = True
92 # If true, sectionauthor and moduleauthor directives will be shown in the
93 # output. They are ignored by default.
96 # The name of the Pygments (syntax highlighting) style to use.
97 pygments_style = 'sphinx'
99 # A list of ignored prefixes for module index sorting.
100 #modindex_common_prefix = []
102 # If true, keep warnings as "system message" paragraphs in the built documents.
103 #keep_warnings = False
105 # If true, `todo` and `todoList` produce output, else they produce nothing.
106 todo_include_todos = False
109 # -- Options for HTML output ----------------------------------------------
111 # The theme to use for HTML and HTML Help pages. See the documentation for
112 # a list of builtin themes.
113 html_theme = 'bootstrap'
115 # Theme options are theme-specific and customize the look and feel of a theme
116 # further. For a list of options available for each theme, see the
118 #html_theme_options = {}
119 html_theme_options = {
120 'bootswatch_theme': "united",
121 'navbar_sidebarrel': False,
122 'source_link_position': "footer",
125 # Add any paths that contain custom themes here, relative to this directory.
126 #html_theme_path = []
127 html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
129 # The name for this set of Sphinx documents.
130 # "<project> v<release> documentation" by default.
131 #html_title = 'OpenDaylight Documentation v0.3.0'
133 # A shorter title for the navigation bar. Default is the same as html_title.
134 #html_short_title = None
136 # The name of an image file (relative to this directory) to place at the top
138 html_logo = '_static/odl_small.png'
140 # The name of an image file (relative to this directory) to use as a favicon of
141 # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
143 html_favicon = 'favicon.ico'
145 # Add any paths that contain custom static files (such as style sheets) here,
146 # relative to this directory. They are copied after the builtin static files,
147 # so a file named "default.css" will overwrite the builtin "default.css".
148 html_static_path = ['_static']
150 # Add any extra paths that contain custom files (such as robots.txt or
151 # .htaccess) here, relative to this directory. These files are copied
152 # directly to the root of the documentation.
153 #html_extra_path = []
155 # If not None, a 'Last updated on:' timestamp is inserted at every page
156 # bottom, using the given strftime format.
157 # The empty string is equivalent to '%b %d, %Y'.
158 #html_last_updated_fmt = None
160 # If true, SmartyPants will be used to convert quotes and dashes to
161 # typographically correct entities.
162 #html_use_smartypants = True
164 # Custom sidebar templates, maps document names to template names.
166 '**': ['localtoc.html', 'relations.html'],
169 # Additional templates that should be rendered to pages, maps page names to
171 #html_additional_pages = {}
173 # If false, no module index is generated.
174 #html_domain_indices = True
176 # If false, no index is generated.
177 #html_use_index = True
179 # If true, the index is split into individual pages for each letter.
180 #html_split_index = False
182 # If true, links to the reST sources are added to the pages.
183 #html_show_sourcelink = True
185 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
186 #html_show_sphinx = True
188 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
189 #html_show_copyright = True
191 # If true, an OpenSearch description file will be output, and all pages will
192 # contain a <link> tag referring to it. The value of this option must be the
193 # base URL from which the finished HTML is served.
194 #html_use_opensearch = ''
196 # This is the file name suffix for HTML files (e.g. ".xhtml").
197 #html_file_suffix = None
199 # Language to be used for generating the HTML full-text search index.
200 # Sphinx supports the following languages:
201 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
202 # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
203 #html_search_language = 'en'
205 # A dictionary with options for the search language support, empty by default.
206 # 'ja' uses this config value.
207 # 'zh' user can custom change `jieba` dictionary path.
208 #html_search_options = {'type': 'default'}
210 # The name of a javascript file (relative to the configuration directory) that
211 # implements a search results scorer. If empty, the default will be used.
212 #html_search_scorer = 'scorer.js'
215 'version_status': 'unsupported',
218 # Output file base name for HTML help builder.
219 htmlhelp_basename = 'OpenDaylightDocumentationdoc'
221 # -- Options for LaTeX output ---------------------------------------------
224 # The paper size ('letterpaper' or 'a4paper').
225 #'papersize': 'letterpaper',
227 # The font size ('10pt', '11pt' or '12pt').
228 #'pointsize': '10pt',
230 # Additional stuff for the LaTeX preamble.
233 # Latex figure (float) alignment
234 #'figure_align': 'htbp',
237 # Grouping the document tree into LaTeX files. List of tuples
238 # (source start file, target name, title,
239 # author, documentclass [howto, manual, or own class]).
241 (master_doc, 'OpenDaylightDocumentation.tex', 'OpenDaylight Documentation Documentation',
242 'OpenDaylight Project', 'manual'),
245 # The name of an image file (relative to this directory) to place at the top of
249 # For "manual" documents, if this is true, then toplevel headings are parts,
251 #latex_use_parts = False
253 # If true, show page references after internal links.
254 #latex_show_pagerefs = False
256 # If true, show URL addresses after external links.
257 #latex_show_urls = False
259 # Documents to append as an appendix to all manuals.
260 #latex_appendices = []
262 # If false, no module index is generated.
263 #latex_domain_indices = True
266 # -- Options for manual page output ---------------------------------------
268 # One entry per manual page. List of tuples
269 # (source start file, name, description, authors, manual section).
271 (master_doc, 'opendaylightdocumentation', 'OpenDaylight Documentation Documentation',
275 # If true, show URL addresses after external links.
276 #man_show_urls = False
279 # -- Options for Texinfo output -------------------------------------------
281 # Grouping the document tree into Texinfo files. List of tuples
282 # (source start file, target name, title, author,
283 # dir menu entry, description, category)
284 texinfo_documents = [
285 (master_doc, 'OpenDaylightDocumentation', 'OpenDaylight Documentation Documentation',
286 author, 'OpenDaylightDocumentation', 'One line description of project.',
290 # Documents to append as an appendix to all manuals.
291 #texinfo_appendices = []
293 # If false, no module index is generated.
294 #texinfo_domain_indices = True
296 # How to display URL addresses: 'footnote', 'no', or 'inline'.
297 #texinfo_show_urls = 'footnote'
299 # If true, do not generate a @detailmenu in the "Top" node's menu.
300 #texinfo_no_detailmenu = False
304 # Ignore jenkins because it's often slow to respond.
305 'https://jenkins.opendaylight.org/releng',
306 'https://jenkins.opendaylight.org/sandbox',
307 'http://\$CONTROL_HOST:8181/dlux/index.html',
308 # The '#' in the path makes sphinx think it's an anchor
309 'https://git.opendaylight.org/gerrit/#/admin/projects/releng/builder',
315 if platform.system() != 'Windows':
317 # Build integration stuff
320 subprocess.call(["./build-integration-robot-libdoc.sh"])