2 # -*- coding: utf-8 -*-
4 # ODL Parent documentation build configuration file, created by
5 # sphinx-quickstart on Fri Nov 10 10:14:30 2017.
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.
16 # If extensions (or modules to document with autodoc) are in another directory,
17 # add these directories to sys.path here. If the directory is relative to the
18 # documentation root, use os.path.abspath to make it absolute, like shown here.
22 # sys.path.insert(0, os.path.abspath('.'))
25 # -- General configuration ------------------------------------------------
27 # If your documentation needs a minimal Sphinx version, state it here.
29 # needs_sphinx = '1.0'
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']
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:
42 # source_suffix = ['.rst', '.md']
43 source_suffix = '.rst'
45 # The master toctree document.
48 # General information about the project.
49 project = 'ODL Parent'
50 copyright = '2017, The OpenDaylight community'
51 author = 'OpenDaylight Project'
53 # The version info for the project you're documenting, acts as replacement for
54 # |version| and |release|, also used in various other places throughout the
57 # The short X.Y version.
59 # The full version, including alpha/beta/rc tags.
62 # The language for content autogenerated by Sphinx. Refer to documentation
63 # for a list of supported languages.
65 # This is also used if you do content translation via gettext catalogs.
66 # Usually you set "language" from the command line for these cases.
69 # List of patterns, relative to source directory, that match files and
70 # directories to ignore when looking for source files.
71 # This patterns also effect to html_static_path and html_extra_path
72 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
74 # The name of the Pygments (syntax highlighting) style to use.
75 pygments_style = 'sphinx'
77 # If true, `todo` and `todoList` produce output, else they produce nothing.
78 todo_include_todos = False
81 # -- Options for HTML output ----------------------------------------------
83 # The theme to use for HTML and HTML Help pages. See the documentation for
84 # a list of builtin themes.
86 html_theme = 'alabaster'
88 # Theme options are theme-specific and customize the look and feel of a theme
89 # further. For a list of options available for each theme, see the
92 # html_theme_options = {}
94 # Add any paths that contain custom static files (such as style sheets) here,
95 # relative to this directory. They are copied after the builtin static files,
96 # so a file named "default.css" will overwrite the builtin "default.css".
97 html_static_path = ['_static']
100 # -- Options for HTMLHelp output ------------------------------------------
102 # Output file base name for HTML help builder.
103 htmlhelp_basename = 'ODLParentdoc'
106 # -- Options for LaTeX output ---------------------------------------------
109 # The paper size ('letterpaper' or 'a4paper').
111 # 'papersize': 'letterpaper',
113 # The font size ('10pt', '11pt' or '12pt').
115 # 'pointsize': '10pt',
117 # Additional stuff for the LaTeX preamble.
121 # Latex figure (float) alignment
123 # 'figure_align': 'htbp',
126 # Grouping the document tree into LaTeX files. List of tuples
127 # (source start file, target name, title,
128 # author, documentclass [howto, manual, or own class]).
130 (master_doc, 'ODLParent.tex', 'ODL Parent Documentation',
131 'The OpenDaylight community', 'manual'),
135 # -- Options for manual page output ---------------------------------------
137 # One entry per manual page. List of tuples
138 # (source start file, name, description, authors, manual section).
140 (master_doc, 'odlparent', 'ODL Parent Documentation',
145 # -- Options for Texinfo output -------------------------------------------
147 # Grouping the document tree into Texinfo files. List of tuples
148 # (source start file, target name, title, author,
149 # dir menu entry, description, category)
150 texinfo_documents = [
151 (master_doc, 'ODLParent', 'ODL Parent Documentation',
152 author, 'ODLParent', 'One line description of project.',