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.
19 import sphinx_bootstrap_theme
21 # If extensions (or modules to document with autodoc) are in another directory,
22 # add these directories to sys.path here. If the directory is relative to the
23 # documentation root, use os.path.abspath to make it absolute, like shown here.
24 sys.path.insert(0, os.path.abspath('submodules/spectrometer/server'))
26 # -- General configuration ------------------------------------------------
28 # If your documentation needs a minimal Sphinx version, state it here.
31 # Add any Sphinx extension module names here, as strings. They can be
32 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
34 extensions = ['sphinx.ext.autodoc','sphinx.ext.graphviz']
36 # Add any paths that contain templates here, relative to this directory.
37 templates_path = ['_templates']
39 # The suffix(es) of source filenames.
40 # You can specify multiple suffix as a list of string:
41 # source_suffix = ['.rst', '.md']
42 source_suffix = '.rst'
44 # The encoding of source files.
45 #source_encoding = 'utf-8-sig'
47 # The master toctree document.
50 # General information about the project.
51 project = 'OpenDaylight Documentation'
52 copyright = '2016-{}, OpenDaylight Project'.format(time.strftime("%Y"))
53 author = 'OpenDaylight Project'
55 # The version info for the project you're documenting, acts as replacement for
56 # |version| and |release|, also used in various other places throughout the
58 version = 'Oxygen' # The short X.Y version.
59 release = version # The full version, including alpha/beta/rc tags.
61 # The language for content autogenerated by Sphinx. Refer to documentation
62 # for a list of supported languages.
64 # This is also used if you do content translation via gettext catalogs.
65 # Usually you set "language" from the command line for these cases.
68 # There are two options for replacing |today|: either, you set today to some
69 # non-false value, then it is used:
71 # Else, today_fmt is used as the format for a strftime call.
72 #today_fmt = '%B %d, %Y'
74 # List of patterns, relative to source directory, that match files and
75 # directories to ignore when looking for source files.
76 # This patterns also effect to html_static_path and html_extra_path
79 # The reST default role (used for this markup: `text`) to use for all
83 # If true, '()' will be appended to :func: etc. cross-reference text.
84 #add_function_parentheses = True
86 # If true, the current module name will be prepended to all description
87 # unit titles (such as .. function::).
88 #add_module_names = True
90 # If true, sectionauthor and moduleauthor directives will be shown in the
91 # output. They are ignored by default.
94 # The name of the Pygments (syntax highlighting) style to use.
95 pygments_style = 'sphinx'
97 # A list of ignored prefixes for module index sorting.
98 #modindex_common_prefix = []
100 # If true, keep warnings as "system message" paragraphs in the built documents.
101 #keep_warnings = False
103 # If true, `todo` and `todoList` produce output, else they produce nothing.
104 todo_include_todos = False
107 # -- Options for HTML output ----------------------------------------------
109 # The theme to use for HTML and HTML Help pages. See the documentation for
110 # a list of builtin themes.
111 html_theme = 'bootstrap'
113 # Theme options are theme-specific and customize the look and feel of a theme
114 # further. For a list of options available for each theme, see the
116 #html_theme_options = {}
117 html_theme_options = {
118 'bootswatch_theme': "united",
119 'navbar_sidebarrel': False,
120 'source_link_position': "footer",
123 # Add any paths that contain custom themes here, relative to this directory.
124 #html_theme_path = []
125 html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
127 # The name for this set of Sphinx documents.
128 # "<project> v<release> documentation" by default.
129 #html_title = 'OpenDaylight Documentation v0.3.0'
131 # A shorter title for the navigation bar. Default is the same as html_title.
132 #html_short_title = None
134 # The name of an image file (relative to this directory) to place at the top
136 html_logo = '_static/odl_small.png'
138 # The name of an image file (relative to this directory) to use as a favicon of
139 # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
141 html_favicon = 'favicon.ico'
143 # Add any paths that contain custom static files (such as style sheets) here,
144 # relative to this directory. They are copied after the builtin static files,
145 # so a file named "default.css" will overwrite the builtin "default.css".
146 html_static_path = ['_static']
148 # Add any extra paths that contain custom files (such as robots.txt or
149 # .htaccess) here, relative to this directory. These files are copied
150 # directly to the root of the documentation.
151 #html_extra_path = []
153 # If not None, a 'Last updated on:' timestamp is inserted at every page
154 # bottom, using the given strftime format.
155 # The empty string is equivalent to '%b %d, %Y'.
156 #html_last_updated_fmt = None
158 # If true, SmartyPants will be used to convert quotes and dashes to
159 # typographically correct entities.
160 #html_use_smartypants = True
162 # Custom sidebar templates, maps document names to template names.
164 '**': ['localtoc.html', 'relations.html'],
167 # Additional templates that should be rendered to pages, maps page names to
169 #html_additional_pages = {}
171 # If false, no module index is generated.
172 #html_domain_indices = True
174 # If false, no index is generated.
175 #html_use_index = True
177 # If true, the index is split into individual pages for each letter.
178 #html_split_index = False
180 # If true, links to the reST sources are added to the pages.
181 #html_show_sourcelink = True
183 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
184 #html_show_sphinx = True
186 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
187 #html_show_copyright = True
189 # If true, an OpenSearch description file will be output, and all pages will
190 # contain a <link> tag referring to it. The value of this option must be the
191 # base URL from which the finished HTML is served.
192 #html_use_opensearch = ''
194 # This is the file name suffix for HTML files (e.g. ".xhtml").
195 #html_file_suffix = None
197 # Language to be used for generating the HTML full-text search index.
198 # Sphinx supports the following languages:
199 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
200 # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
201 #html_search_language = 'en'
203 # A dictionary with options for the search language support, empty by default.
204 # 'ja' uses this config value.
205 # 'zh' user can custom change `jieba` dictionary path.
206 #html_search_options = {'type': 'default'}
208 # The name of a javascript file (relative to the configuration directory) that
209 # implements a search results scorer. If empty, the default will be used.
210 #html_search_scorer = 'scorer.js'
212 # Output file base name for HTML help builder.
213 htmlhelp_basename = 'OpenDaylightDocumentation'
216 # Ignore jenkins because it's often slow to respond.
217 'https://jenkins.opendaylight.org/releng',
218 'https://jenkins.opendaylight.org/sandbox',
219 'http://\$CONTROL_HOST:8181/dlux/index.html',
220 # The '#' in the path makes sphinx think it's an anchor
221 'https://git.opendaylight.org/gerrit/#/admin/projects/releng/builder',
227 if platform.system() != 'Windows':
229 # Build integration stuff
232 subprocess.call(["./generate-milestone-status.sh"])
233 subprocess.call(["./build-integration-robot-libdoc.sh"])