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