Update git submodules
[opnfvdocs.git] / docs / conf.py
1 import sphinx_bootstrap_theme
2 import os
3
4 # If extensions (or modules to document with autodoc) are in another directory,
5 # add these directories to sys.path here. If the directory is relative to the
6 # documentation root, use os.path.abspath to make it absolute, like shown here.
7 # -- General configuration ------------------------------------------------
8
9 # If your documentation needs a minimal Sphinx version, state it here.
10 # needs_sphinx = '1.0'
11 needs_sphinx = '1.3'
12 # Add any Sphinx extension module names here, as strings. They can be
13 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
14 # ones.
15 extensions = ['sphinxcontrib.httpdomain', 'sphinx.ext.autodoc',
16               'sphinx.ext.viewcode', 'sphinx.ext.napoleon']
17 # Disable javasphinx generation until we have a solution to long build
18 # times. readthedocs timesout after 902 seconds.
19
20 # Add any paths that contain templates here, relative to this directory.
21 templates_path = ['_templates']
22
23 # The suffix(es) of source filenames.
24 # You can specify multiple suffix as a list of string:
25 # source_suffix = ['.rst', '.md']
26 source_suffix = '.rst'
27
28 # The encoding of source files.
29 # source_encoding = 'utf-8-sig'
30
31 # The master toctree document.
32 master_doc = 'index'
33
34 # General information about the project.
35 project = ''
36 copyright = '2017, OPNFV. Licensed under CC BY 4.0'
37 author = 'Open Platform for NFV'
38
39 # The version info for the project you're documenting, acts as replacement for
40 # |version| and |release|, also used in various other places throughout the
41 # built documents.
42 #
43 # The short X.Y version.
44 version = 'Latest'
45 # The full version, including alpha/beta/rc tags.
46 release = 'Latest'
47
48 # The language for content autogenerated by Sphinx. Refer to documentation
49 # for a list of supported languages.
50 #
51 # This is also used if you do content translation via gettext catalogs.
52 # Usually you set "language" from the command line for these cases.
53 language = None
54
55 # There are two options for replacing |today|: either, you set today to some
56 # non-false value, then it is used:
57 # today = ''
58 # Else, today_fmt is used as the format for a strftime call.
59 # today_fmt = '%B %d, %Y'
60
61 # List of patterns, relative to source directory, that match files and
62 # directories to ignore when looking for source files.
63 # This patterns also effect to html_static_path and html_extra_path
64 exclude_patterns = []
65
66 # The reST default role (used for this markup: `text`) to use for all
67 # documents.
68 # default_role = None
69
70 # If true, '()' will be appended to :func: etc. cross-reference text.
71 # add_function_parentheses = True
72
73 # If true, the current module name will be prepended to all description
74 # unit titles (such as .. function::).
75 # add_module_names = True
76
77 # If true, sectionauthor and moduleauthor directives will be shown in the
78 # output. They are ignored by default.
79 # show_authors = False
80
81 # The name of the Pygments (syntax highlighting) style to use.
82 pygments_style = 'sphinx'
83
84 # A list of ignored prefixes for module index sorting.
85 # modindex_common_prefix = []
86
87 # If true, keep warnings as "system message" paragraphs in the built documents.
88 # keep_warnings = False
89
90 # If true, `todo` and `todoList` produce output, else they produce nothing.
91 todo_include_todos = False
92
93
94 # -- Options for HTML output ----------------------------------------------
95
96 # The theme to use for HTML and HTML Help pages.  See the documentation for
97 # a list of builtin themes.
98 html_theme = 'bootstrap'
99
100 # Theme options are theme-specific and customize the look and feel of a theme
101 # further.  For a list of options available for each theme, see the
102 # documentation.
103 # html_theme_options = {}
104 html_theme_options = {
105     'bootswatch_theme': "journal",
106     'navbar_sidebarrel': False,
107 }
108
109 # Add any paths that contain custom themes here, relative to this directory.
110 # html_theme_path = []
111 html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
112
113 # The name for this set of Sphinx documents.
114 # "<project> v<release> documentation" by default.
115 # html_title = 'OpenDaylight Documentation v0.3.0'
116
117 # A shorter title for the navigation bar.  Default is the same as html_title.
118 # html_short_title = None
119
120 # The name of an image file (relative to this directory) to place at the top
121 # of the sidebar.
122 html_logo = '_static/opnfv-logo.png'
123
124 # The name of an image file (relative to this directory) to use as a favicon of
125 # the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
126 # pixels large.
127 html_favicon = '_static/favicon.ico'
128
129 # Add any paths that contain custom static files (such as style sheets) here,
130 # relative to this directory. They are copied after the builtin static files,
131 # so a file named "default.css" will overwrite the builtin "default.css".
132 html_static_path = ['_static']
133
134 # Add any extra paths that contain custom files (such as robots.txt or
135 # .htaccess) here, relative to this directory. These files are copied
136 # directly to the root of the documentation.
137 # html_extra_path = []
138
139 # If not None, a 'Last updated on:' timestamp is inserted at every page
140 # bottom, using the given strftime format.
141 # The empty string is equivalent to '%b %d, %Y'.
142 # html_last_updated_fmt = None
143
144 # If true, SmartyPants will be used to convert quotes and dashes to
145 # typographically correct entities.
146 # html_use_smartypants = True
147
148 # Custom sidebar templates, maps document names to template names.
149 # html_sidebars = {}
150
151 # Additional templates that should be rendered to pages, maps page names to
152 # template names.
153 # html_additional_pages = {}
154
155 # If false, no module index is generated.
156 # html_domain_indices = True
157
158 # If false, no index is generated.
159 # html_use_index = True
160
161 # If true, the index is split into individual pages for each letter.
162 # html_split_index = False
163
164 # If true, links to the reST sources are added to the pages.
165 # html_show_sourcelink = True
166
167 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
168 # html_show_sphinx = True
169
170 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
171 # html_show_copyright = True
172
173 # If true, an OpenSearch description file will be output, and all pages will
174 # contain a <link> tag referring to it.  The value of this option must be the
175 # base URL from which the finished HTML is served.
176 # html_use_opensearch = ''
177
178 # This is the file name suffix for HTML files (e.g. ".xhtml").
179 # html_file_suffix = None
180
181 # Language to be used for generating the HTML full-text search index.
182 # Sphinx supports the following languages:
183 #   'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
184 #   'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
185 # html_search_language = 'en'
186
187 # A dictionary with options for the search language support, empty by default.
188 # 'ja' uses this config value.
189 # 'zh' user can custom change `jieba` dictionary path.
190 # html_search_options = {'type': 'default'}
191
192 # The name of a javascript file (relative to the configuration directory) that
193 # implements a search results scorer. If empty, the default will be used.
194 # html_search_scorer = 'scorer.js'
195
196 # Output file base name for HTML help builder.
197 htmlhelp_basename = 'OPNFV'
198
199 # -- Options for LaTeX output ---------------------------------------------
200
201 latex_elements = {
202     # The paper size ('letterpaper' or 'a4paper').
203     #'papersize': 'letterpaper',
204
205     # The font size ('10pt', '11pt' or '12pt').
206     #'pointsize': '10pt',
207
208     # Additional stuff for the LaTeX preamble.
209     #'preamble': '',
210
211     # Latex figure (float) alignment
212     #'figure_align': 'htbp',
213 }
214
215 # Grouping the document tree into LaTeX files. List of tuples
216 # (source start file, target name, title,
217 #  author, documentclass [howto, manual, or own class]).
218 latex_documents = [
219     (master_doc, 'OPNFV.tex', 'OPNFV Documentation',
220      'OPNFV Project', 'manual'),
221 ]
222
223 # The name of an image file (relative to this directory) to place at the top of
224 # the title page.
225 # latex_logo = None
226
227 # For "manual" documents, if this is true, then toplevel headings are parts,
228 # not chapters.
229 # latex_use_parts = False
230
231 # If true, show page references after internal links.
232 # latex_show_pagerefs = False
233
234 # If true, show URL addresses after external links.
235 # latex_show_urls = False
236
237 # Documents to append as an appendix to all manuals.
238 # latex_appendices = []
239
240 # If false, no module index is generated.
241 # latex_domain_indices = True
242
243
244 # -- Options for manual page output ---------------------------------------
245
246 # One entry per manual page. List of tuples
247 # (source start file, name, description, authors, manual section).
248 man_pages = [
249     (master_doc, 'OPNFVDocs', 'OPNFV Documentation',
250      [author], 1)
251 ]
252
253 # If true, show URL addresses after external links.
254 # man_show_urls = False
255
256
257 # -- Options for Texinfo output -------------------------------------------
258
259 # Grouping the document tree into Texinfo files. List of tuples
260 # (source start file, target name, title, author,
261 #  dir menu entry, description, category)
262 texinfo_documents = [
263     (master_doc, 'OPNFVDocs', 'OPNFV Documentation',
264      author, 'OPNFV', 'One line description of project.',
265      'Miscellaneous'),
266 ]
267
268 html_sidebars = {'**': ['localtoc.html', 'relations.html'],}
269 # Documents to append as an appendix to all manuals.
270 # texinfo_appendices = []
271
272 # If false, no module index is generated.
273 # texinfo_domain_indices = True
274
275 # How to display URL addresses: 'footnote', 'no', or 'inline'.
276 # texinfo_show_urls = 'footnote'
277
278 # If true, do not generate a @detailmenu in the "Top" node's menu.
279 # texinfo_no_detailmenu = False
280
281 # intersphinx_mapping =
282 # {'RTD':('http://opnfvdocsdemo.readthedocs.io/projects/', None)}