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.
8 subprocess.call(["rm", "-rf", "*"])
10 # -- General configuration ------------------------------------------------
12 # If your documentation needs a minimal Sphinx version, state it here.
13 # needs_sphinx = '1.0'
15 # Add any Sphinx extension module names here, as strings. They can be
16 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
18 extensions = ['sphinxcontrib.httpdomain', 'sphinx.ext.autodoc',
19 'sphinx.ext.viewcode', 'sphinx.ext.napoleon']
20 # Disable javasphinx generation until we have a solution to long build
21 # times. readthedocs timesout after 902 seconds.
23 # Add any paths that contain templates here, relative to this directory.
24 templates_path = ['_templates']
26 # The suffix(es) of source filenames.
27 # You can specify multiple suffix as a list of string:
28 # source_suffix = ['.rst', '.md']
29 source_suffix = '.rst'
31 # The encoding of source files.
32 # source_encoding = 'utf-8-sig'
34 # The master toctree document.
37 # General information about the project.
38 project = 'Documentation'
39 copyright = '2017, OPNFV. Licensed under CC BY 4.0'
40 author = 'Open Platform for NFV'
42 # The version info for the project you're documenting, acts as replacement for
43 # |version| and |release|, also used in various other places throughout the
46 # The short X.Y version.
48 # The full version, including alpha/beta/rc tags.
51 # The language for content autogenerated by Sphinx. Refer to documentation
52 # for a list of supported languages.
54 # This is also used if you do content translation via gettext catalogs.
55 # Usually you set "language" from the command line for these cases.
58 # There are two options for replacing |today|: either, you set today to some
59 # non-false value, then it is used:
61 # Else, today_fmt is used as the format for a strftime call.
62 # today_fmt = '%B %d, %Y'
64 # List of patterns, relative to source directory, that match files and
65 # directories to ignore when looking for source files.
66 # This patterns also effect to html_static_path and html_extra_path
69 # The reST default role (used for this markup: `text`) to use for all
73 # If true, '()' will be appended to :func: etc. cross-reference text.
74 # add_function_parentheses = True
76 # If true, the current module name will be prepended to all description
77 # unit titles (such as .. function::).
78 # add_module_names = True
80 # If true, sectionauthor and moduleauthor directives will be shown in the
81 # output. They are ignored by default.
82 # show_authors = False
84 # The name of the Pygments (syntax highlighting) style to use.
85 pygments_style = 'sphinx'
87 # A list of ignored prefixes for module index sorting.
88 # modindex_common_prefix = []
90 # If true, keep warnings as "system message" paragraphs in the built documents.
91 # keep_warnings = False
93 # If true, `todo` and `todoList` produce output, else they produce nothing.
94 todo_include_todos = False
97 # -- Options for HTML output ----------------------------------------------
99 # The theme to use for HTML and HTML Help pages. See the documentation for
100 # a list of builtin themes.
101 html_theme = 'bootstrap'
103 # Theme options are theme-specific and customize the look and feel of a theme
104 # further. For a list of options available for each theme, see the
106 # html_theme_options = {}
107 html_theme_options = {
108 'bootswatch_theme': "united",
111 # Add any paths that contain custom themes here, relative to this directory.
112 # html_theme_path = []
113 html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
115 # The name for this set of Sphinx documents.
116 # "<project> v<release> documentation" by default.
117 # html_title = 'OpenDaylight Documentation v0.3.0'
119 # A shorter title for the navigation bar. Default is the same as html_title.
120 # html_short_title = None
122 # The name of an image file (relative to this directory) to place at the top
124 html_logo = '_static/opnfv-logo.png'
126 # The name of an image file (relative to this directory) to use as a favicon of
127 # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
129 html_favicon = '_static/favicon.ico'
131 # Add any paths that contain custom static files (such as style sheets) here,
132 # relative to this directory. They are copied after the builtin static files,
133 # so a file named "default.css" will overwrite the builtin "default.css".
134 html_static_path = ['_static']
136 # Add any extra paths that contain custom files (such as robots.txt or
137 # .htaccess) here, relative to this directory. These files are copied
138 # directly to the root of the documentation.
139 # html_extra_path = []
141 # If not None, a 'Last updated on:' timestamp is inserted at every page
142 # bottom, using the given strftime format.
143 # The empty string is equivalent to '%b %d, %Y'.
144 # html_last_updated_fmt = None
146 # If true, SmartyPants will be used to convert quotes and dashes to
147 # typographically correct entities.
148 # html_use_smartypants = True
150 # Custom sidebar templates, maps document names to template names.
153 # Additional templates that should be rendered to pages, maps page names to
155 # html_additional_pages = {}
157 # If false, no module index is generated.
158 # html_domain_indices = True
160 # If false, no index is generated.
161 # html_use_index = True
163 # If true, the index is split into individual pages for each letter.
164 # html_split_index = False
166 # If true, links to the reST sources are added to the pages.
167 # html_show_sourcelink = True
169 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
170 # html_show_sphinx = True
172 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
173 # html_show_copyright = True
175 # If true, an OpenSearch description file will be output, and all pages will
176 # contain a <link> tag referring to it. The value of this option must be the
177 # base URL from which the finished HTML is served.
178 # html_use_opensearch = ''
180 # This is the file name suffix for HTML files (e.g. ".xhtml").
181 # html_file_suffix = None
183 # Language to be used for generating the HTML full-text search index.
184 # Sphinx supports the following languages:
185 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
186 # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
187 # html_search_language = 'en'
189 # A dictionary with options for the search language support, empty by default.
190 # 'ja' uses this config value.
191 # 'zh' user can custom change `jieba` dictionary path.
192 # html_search_options = {'type': 'default'}
194 # The name of a javascript file (relative to the configuration directory) that
195 # implements a search results scorer. If empty, the default will be used.
196 # html_search_scorer = 'scorer.js'
198 # Output file base name for HTML help builder.
199 htmlhelp_basename = 'OPNFV'
201 # -- Options for LaTeX output ---------------------------------------------
204 # The paper size ('letterpaper' or 'a4paper').
205 #'papersize': 'letterpaper',
207 # The font size ('10pt', '11pt' or '12pt').
208 #'pointsize': '10pt',
210 # Additional stuff for the LaTeX preamble.
213 # Latex figure (float) alignment
214 #'figure_align': 'htbp',
217 # Grouping the document tree into LaTeX files. List of tuples
218 # (source start file, target name, title,
219 # author, documentclass [howto, manual, or own class]).
221 (master_doc, 'OPNFV.tex', 'OPNFV Documentation',
222 'OPNFV Project', 'manual'),
225 # The name of an image file (relative to this directory) to place at the top of
229 # For "manual" documents, if this is true, then toplevel headings are parts,
231 # latex_use_parts = False
233 # If true, show page references after internal links.
234 # latex_show_pagerefs = False
236 # If true, show URL addresses after external links.
237 # latex_show_urls = False
239 # Documents to append as an appendix to all manuals.
240 # latex_appendices = []
242 # If false, no module index is generated.
243 # latex_domain_indices = True
246 # -- Options for manual page output ---------------------------------------
248 # One entry per manual page. List of tuples
249 # (source start file, name, description, authors, manual section).
251 (master_doc, 'OPNFVDocs', 'OPNFV Documentation',
255 # If true, show URL addresses after external links.
256 # man_show_urls = False
259 # -- Options for Texinfo output -------------------------------------------
261 # Grouping the document tree into Texinfo files. List of tuples
262 # (source start file, target name, title, author,
263 # dir menu entry, description, category)
264 texinfo_documents = [
265 (master_doc, 'OPNFVDocs', 'OPNFV Documentation',
266 author, 'OPNFV', 'One line description of project.',
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 # {'RTD':('http://opnfvdocsdemo.readthedocs.io/projects/', None)}