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 # Disable javasphinx generation until we have a solution to long build
36 # times. readthedocs timesout after 902 seconds.
37 javasphinx_available = False
40 javasphinx_available = True
41 extensions.append('javasphinx')
42 except ImportError, e:
45 # Add any paths that contain templates here, relative to this directory.
46 templates_path = ['_templates']
48 # The suffix(es) of source filenames.
49 # You can specify multiple suffix as a list of string:
50 # source_suffix = ['.rst', '.md']
51 source_suffix = '.rst'
53 # The encoding of source files.
54 #source_encoding = 'utf-8-sig'
56 # The master toctree document.
59 # General information about the project.
60 project = 'OpenDaylight Documentation'
61 copyright = '2016, OpenDaylight Project'
62 author = 'OpenDaylight Project'
64 # The version info for the project you're documenting, acts as replacement for
65 # |version| and |release|, also used in various other places throughout the
68 # The short X.Y version.
70 # The full version, including alpha/beta/rc tags.
73 # The language for content autogenerated by Sphinx. Refer to documentation
74 # for a list of supported languages.
76 # This is also used if you do content translation via gettext catalogs.
77 # Usually you set "language" from the command line for these cases.
80 # There are two options for replacing |today|: either, you set today to some
81 # non-false value, then it is used:
83 # Else, today_fmt is used as the format for a strftime call.
84 #today_fmt = '%B %d, %Y'
86 # List of patterns, relative to source directory, that match files and
87 # directories to ignore when looking for source files.
88 # This patterns also effect to html_static_path and html_extra_path
91 # The reST default role (used for this markup: `text`) to use for all
95 # If true, '()' will be appended to :func: etc. cross-reference text.
96 #add_function_parentheses = True
98 # If true, the current module name will be prepended to all description
99 # unit titles (such as .. function::).
100 #add_module_names = True
102 # If true, sectionauthor and moduleauthor directives will be shown in the
103 # output. They are ignored by default.
104 #show_authors = False
106 # The name of the Pygments (syntax highlighting) style to use.
107 pygments_style = 'sphinx'
109 # A list of ignored prefixes for module index sorting.
110 #modindex_common_prefix = []
112 # If true, keep warnings as "system message" paragraphs in the built documents.
113 #keep_warnings = False
115 # If true, `todo` and `todoList` produce output, else they produce nothing.
116 todo_include_todos = False
119 # -- Options for HTML output ----------------------------------------------
121 # The theme to use for HTML and HTML Help pages. See the documentation for
122 # a list of builtin themes.
123 html_theme = 'bootstrap'
125 # Theme options are theme-specific and customize the look and feel of a theme
126 # further. For a list of options available for each theme, see the
128 #html_theme_options = {}
129 html_theme_options = {
130 'bootswatch_theme': "united",
131 'navbar_sidebarrel': False,
132 'source_link_position': "footer",
135 # Add any paths that contain custom themes here, relative to this directory.
136 #html_theme_path = []
137 html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
139 # The name for this set of Sphinx documents.
140 # "<project> v<release> documentation" by default.
141 #html_title = 'OpenDaylight Documentation v0.3.0'
143 # A shorter title for the navigation bar. Default is the same as html_title.
144 #html_short_title = None
146 # The name of an image file (relative to this directory) to place at the top
148 html_logo = '_static/odl_small.png'
150 # The name of an image file (relative to this directory) to use as a favicon of
151 # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
153 html_favicon = 'favicon.ico'
155 # Add any paths that contain custom static files (such as style sheets) here,
156 # relative to this directory. They are copied after the builtin static files,
157 # so a file named "default.css" will overwrite the builtin "default.css".
158 html_static_path = ['_static']
160 # Add any extra paths that contain custom files (such as robots.txt or
161 # .htaccess) here, relative to this directory. These files are copied
162 # directly to the root of the documentation.
163 #html_extra_path = []
165 # If not None, a 'Last updated on:' timestamp is inserted at every page
166 # bottom, using the given strftime format.
167 # The empty string is equivalent to '%b %d, %Y'.
168 #html_last_updated_fmt = None
170 # If true, SmartyPants will be used to convert quotes and dashes to
171 # typographically correct entities.
172 #html_use_smartypants = True
174 # Custom sidebar templates, maps document names to template names.
176 '**': ['localtoc.html', 'relations.html'],
179 # Additional templates that should be rendered to pages, maps page names to
181 #html_additional_pages = {}
183 # If false, no module index is generated.
184 #html_domain_indices = True
186 # If false, no index is generated.
187 #html_use_index = True
189 # If true, the index is split into individual pages for each letter.
190 #html_split_index = False
192 # If true, links to the reST sources are added to the pages.
193 #html_show_sourcelink = True
195 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
196 #html_show_sphinx = True
198 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
199 #html_show_copyright = True
201 # If true, an OpenSearch description file will be output, and all pages will
202 # contain a <link> tag referring to it. The value of this option must be the
203 # base URL from which the finished HTML is served.
204 #html_use_opensearch = ''
206 # This is the file name suffix for HTML files (e.g. ".xhtml").
207 #html_file_suffix = None
209 # Language to be used for generating the HTML full-text search index.
210 # Sphinx supports the following languages:
211 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
212 # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
213 #html_search_language = 'en'
215 # A dictionary with options for the search language support, empty by default.
216 # 'ja' uses this config value.
217 # 'zh' user can custom change `jieba` dictionary path.
218 #html_search_options = {'type': 'default'}
220 # The name of a javascript file (relative to the configuration directory) that
221 # implements a search results scorer. If empty, the default will be used.
222 #html_search_scorer = 'scorer.js'
224 # Output file base name for HTML help builder.
225 htmlhelp_basename = 'OpenDaylightDocumentationdoc'
227 # -- Options for LaTeX output ---------------------------------------------
230 # The paper size ('letterpaper' or 'a4paper').
231 #'papersize': 'letterpaper',
233 # The font size ('10pt', '11pt' or '12pt').
234 #'pointsize': '10pt',
236 # Additional stuff for the LaTeX preamble.
239 # Latex figure (float) alignment
240 #'figure_align': 'htbp',
243 # Grouping the document tree into LaTeX files. List of tuples
244 # (source start file, target name, title,
245 # author, documentclass [howto, manual, or own class]).
247 (master_doc, 'OpenDaylightDocumentation.tex', 'OpenDaylight Documentation Documentation',
248 'OpenDaylight Project', 'manual'),
251 # The name of an image file (relative to this directory) to place at the top of
255 # For "manual" documents, if this is true, then toplevel headings are parts,
257 #latex_use_parts = False
259 # If true, show page references after internal links.
260 #latex_show_pagerefs = False
262 # If true, show URL addresses after external links.
263 #latex_show_urls = False
265 # Documents to append as an appendix to all manuals.
266 #latex_appendices = []
268 # If false, no module index is generated.
269 #latex_domain_indices = True
272 # -- Options for manual page output ---------------------------------------
274 # One entry per manual page. List of tuples
275 # (source start file, name, description, authors, manual section).
277 (master_doc, 'opendaylightdocumentation', 'OpenDaylight Documentation Documentation',
281 # If true, show URL addresses after external links.
282 #man_show_urls = False
285 # -- Options for Texinfo output -------------------------------------------
287 # Grouping the document tree into Texinfo files. List of tuples
288 # (source start file, target name, title, author,
289 # dir menu entry, description, category)
290 texinfo_documents = [
291 (master_doc, 'OpenDaylightDocumentation', 'OpenDaylight Documentation Documentation',
292 author, 'OpenDaylightDocumentation', 'One line description of project.',
296 # Documents to append as an appendix to all manuals.
297 #texinfo_appendices = []
299 # If false, no module index is generated.
300 #texinfo_domain_indices = True
302 # How to display URL addresses: 'footnote', 'no', or 'inline'.
303 #texinfo_show_urls = 'footnote'
305 # If true, do not generate a @detailmenu in the "Top" node's menu.
306 #texinfo_no_detailmenu = False
310 # Ignore jenkins because it's often slow to respond.
311 'https://jenkins.opendaylight.org/releng',
312 'https://jenkins.opendaylight.org/sandbox',
313 'http://\$CONTROL_HOST:8181/dlux/index.html',
314 # The '#' in the path makes sphinx think it's an anchor
315 'https://git.opendaylight.org/gerrit/#/admin/projects/releng/builder',
321 if platform.system() != 'Windows':
323 # Build integration stuff
326 subprocess.call(["./build-integration-robot-libdoc.sh"])
328 # Disable javasphinx generation until we have a solution to long build
329 # times. readthedocs timesout after 902 seconds.
330 if javasphinx_available:
331 subprocess.call(["./generate-javaapidoc.sh"])