dfilppi | 9981f55 | 2017-08-07 20:10:53 +0000 | [diff] [blame] | 1 | # -*- coding: utf-8 -*- |
| 2 | # |
| 3 | # cloudify-openstack-plugin documentation build configuration file, created by |
| 4 | # sphinx-quickstart on Tue Nov 8 14:02:23 2016. |
| 5 | # |
| 6 | # This file is execfile()d with the current directory set to its |
| 7 | # containing dir. |
| 8 | # |
| 9 | # Note that not all possible configuration values are present in this |
| 10 | # autogenerated file. |
| 11 | # |
| 12 | # All configuration values have a default; values that are commented out |
| 13 | # serve to show the default. |
| 14 | |
| 15 | import sys |
| 16 | import os |
| 17 | |
| 18 | # If extensions (or modules to document with autodoc) are in another directory, |
| 19 | # add these directories to sys.path here. If the directory is relative to the |
| 20 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
| 21 | #sys.path.insert(0, os.path.abspath('.')) |
| 22 | |
| 23 | # -- General configuration ------------------------------------------------ |
| 24 | |
| 25 | # If your documentation needs a minimal Sphinx version, state it here. |
| 26 | #needs_sphinx = '1.0' |
| 27 | |
| 28 | # Add any Sphinx extension module names here, as strings. They can be |
| 29 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
| 30 | # ones. |
| 31 | extensions = [ |
| 32 | 'sphinx.ext.autodoc', |
| 33 | 'sphinx.ext.intersphinx', |
| 34 | 'sphinx.ext.todo', |
| 35 | 'sphinx.ext.viewcode', |
| 36 | 'sphinxify', |
| 37 | ] |
| 38 | |
| 39 | # Add any paths that contain templates here, relative to this directory. |
| 40 | templates_path = ['_templates'] |
| 41 | |
| 42 | # The suffix(es) of source filenames. |
| 43 | # You can specify multiple suffix as a list of string: |
| 44 | # source_suffix = ['.rst', '.md'] |
| 45 | source_suffix = '.rst' |
| 46 | |
| 47 | # The encoding of source files. |
| 48 | #source_encoding = 'utf-8-sig' |
| 49 | |
| 50 | # The master toctree document. |
| 51 | master_doc = 'index' |
| 52 | |
| 53 | # General information about the project. |
| 54 | project = u'cloudify-openstack-plugin' |
| 55 | copyright = u'2016-17 GigaSpaces Technologies Ltd.' |
| 56 | author = u'GigaSpaces Technologies Ltd.' |
| 57 | |
| 58 | # The version info for the project you're documenting, acts as replacement for |
| 59 | # |version| and |release|, also used in various other places throughout the |
| 60 | # built documents. |
| 61 | # |
| 62 | # The short X.Y version. |
| 63 | version = u'2.0' |
| 64 | # The full version, including alpha/beta/rc tags. |
| 65 | release = u'2.0' |
| 66 | |
| 67 | # The language for content autogenerated by Sphinx. Refer to documentation |
| 68 | # for a list of supported languages. |
| 69 | # |
| 70 | # This is also used if you do content translation via gettext catalogs. |
| 71 | # Usually you set "language" from the command line for these cases. |
| 72 | language = None |
| 73 | |
| 74 | # There are two options for replacing |today|: either, you set today to some |
| 75 | # non-false value, then it is used: |
| 76 | #today = '' |
| 77 | # Else, today_fmt is used as the format for a strftime call. |
| 78 | #today_fmt = '%B %d, %Y' |
| 79 | |
| 80 | # List of patterns, relative to source directory, that match files and |
| 81 | # directories to ignore when looking for source files. |
| 82 | # This patterns also effect to html_static_path and html_extra_path |
| 83 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 84 | |
| 85 | # The reST default role (used for this markup: `text`) to use for all |
| 86 | # documents. |
| 87 | #default_role = None |
| 88 | |
| 89 | # If true, '()' will be appended to :func: etc. cross-reference text. |
| 90 | #add_function_parentheses = True |
| 91 | |
| 92 | # If true, the current module name will be prepended to all description |
| 93 | # unit titles (such as .. function::). |
| 94 | #add_module_names = True |
| 95 | |
| 96 | # If true, sectionauthor and moduleauthor directives will be shown in the |
| 97 | # output. They are ignored by default. |
| 98 | #show_authors = False |
| 99 | |
| 100 | # The name of the Pygments (syntax highlighting) style to use. |
| 101 | pygments_style = 'sphinx' |
| 102 | |
| 103 | # A list of ignored prefixes for module index sorting. |
| 104 | #modindex_common_prefix = [] |
| 105 | |
| 106 | # If true, keep warnings as "system message" paragraphs in the built documents. |
| 107 | #keep_warnings = False |
| 108 | |
| 109 | # If true, `todo` and `todoList` produce output, else they produce nothing. |
| 110 | todo_include_todos = True |
| 111 | |
| 112 | |
| 113 | # -- Options for HTML output ---------------------------------------------- |
| 114 | |
| 115 | # The theme to use for HTML and HTML Help pages. See the documentation for |
| 116 | # a list of builtin themes. |
| 117 | # html_theme = 'sphinx-rtd-theme' |
| 118 | |
| 119 | # Theme options are theme-specific and customize the look and feel of a theme |
| 120 | # further. For a list of options available for each theme, see the |
| 121 | # documentation. |
| 122 | #html_theme_options = {} |
| 123 | |
| 124 | # Add any paths that contain custom themes here, relative to this directory. |
| 125 | #html_theme_path = [] |
| 126 | |
| 127 | # The name for this set of Sphinx documents. |
| 128 | # "<project> v<release> documentation" by default. |
| 129 | #html_title = u'cloudify-openstack-plugin v1.0a1' |
| 130 | |
| 131 | # A shorter title for the navigation bar. Default is the same as html_title. |
| 132 | #html_short_title = None |
| 133 | |
| 134 | # The name of an image file (relative to this directory) to place at the top |
| 135 | # of the sidebar. |
| 136 | #html_logo = None |
| 137 | |
| 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 |
| 140 | # pixels large. |
| 141 | #html_favicon = None |
| 142 | |
| 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'] |
| 147 | |
| 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 = [] |
| 152 | |
| 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 |
| 157 | |
| 158 | # If true, SmartyPants will be used to convert quotes and dashes to |
| 159 | # typographically correct entities. |
| 160 | #html_use_smartypants = True |
| 161 | |
| 162 | # Custom sidebar templates, maps document names to template names. |
| 163 | #html_sidebars = {} |
| 164 | |
| 165 | # Additional templates that should be rendered to pages, maps page names to |
| 166 | # template names. |
| 167 | #html_additional_pages = {} |
| 168 | |
| 169 | # If false, no module index is generated. |
| 170 | #html_domain_indices = True |
| 171 | |
| 172 | # If false, no index is generated. |
| 173 | #html_use_index = True |
| 174 | |
| 175 | # If true, the index is split into individual pages for each letter. |
| 176 | #html_split_index = False |
| 177 | |
| 178 | # If true, links to the reST sources are added to the pages. |
| 179 | #html_show_sourcelink = True |
| 180 | |
| 181 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
| 182 | #html_show_sphinx = True |
| 183 | |
| 184 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
| 185 | #html_show_copyright = True |
| 186 | |
| 187 | # If true, an OpenSearch description file will be output, and all pages will |
| 188 | # contain a <link> tag referring to it. The value of this option must be the |
| 189 | # base URL from which the finished HTML is served. |
| 190 | #html_use_opensearch = '' |
| 191 | |
| 192 | # This is the file name suffix for HTML files (e.g. ".xhtml"). |
| 193 | #html_file_suffix = None |
| 194 | |
| 195 | # Language to be used for generating the HTML full-text search index. |
| 196 | # Sphinx supports the following languages: |
| 197 | # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' |
| 198 | # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh' |
| 199 | #html_search_language = 'en' |
| 200 | |
| 201 | # A dictionary with options for the search language support, empty by default. |
| 202 | # 'ja' uses this config value. |
| 203 | # 'zh' user can custom change `jieba` dictionary path. |
| 204 | #html_search_options = {'type': 'default'} |
| 205 | |
| 206 | # The name of a javascript file (relative to the configuration directory) that |
| 207 | # implements a search results scorer. If empty, the default will be used. |
| 208 | #html_search_scorer = 'scorer.js' |
| 209 | |
| 210 | # Output file base name for HTML help builder. |
| 211 | htmlhelp_basename = 'cloudify-openstack-plugindoc' |
| 212 | |
| 213 | # -- Options for LaTeX output --------------------------------------------- |
| 214 | |
| 215 | latex_elements = { |
| 216 | # The paper size ('letterpaper' or 'a4paper'). |
| 217 | #'papersize': 'letterpaper', |
| 218 | |
| 219 | # The font size ('10pt', '11pt' or '12pt'). |
| 220 | #'pointsize': '10pt', |
| 221 | |
| 222 | # Additional stuff for the LaTeX preamble. |
| 223 | #'preamble': '', |
| 224 | |
| 225 | # Latex figure (float) alignment |
| 226 | #'figure_align': 'htbp', |
| 227 | } |
| 228 | |
| 229 | # Grouping the document tree into LaTeX files. List of tuples |
| 230 | # (source start file, target name, title, |
| 231 | # author, documentclass [howto, manual, or own class]). |
| 232 | latex_documents = [ |
| 233 | (master_doc, 'cloudify-openstack-plugin.tex', u'cloudify-openstack-plugin Documentation', |
| 234 | u'GigaSpaces Technologies Ltd.', 'manual'), |
| 235 | ] |
| 236 | |
| 237 | # The name of an image file (relative to this directory) to place at the top of |
| 238 | # the title page. |
| 239 | #latex_logo = None |
| 240 | |
| 241 | # For "manual" documents, if this is true, then toplevel headings are parts, |
| 242 | # not chapters. |
| 243 | #latex_use_parts = False |
| 244 | |
| 245 | # If true, show page references after internal links. |
| 246 | #latex_show_pagerefs = False |
| 247 | |
| 248 | # If true, show URL addresses after external links. |
| 249 | #latex_show_urls = False |
| 250 | |
| 251 | # Documents to append as an appendix to all manuals. |
| 252 | #latex_appendices = [] |
| 253 | |
| 254 | # If false, no module index is generated. |
| 255 | #latex_domain_indices = True |
| 256 | |
| 257 | |
| 258 | # -- Options for manual page output --------------------------------------- |
| 259 | |
| 260 | # One entry per manual page. List of tuples |
| 261 | # (source start file, name, description, authors, manual section). |
| 262 | man_pages = [ |
| 263 | (master_doc, 'cloudify-openstack-plugin', u'cloudify-openstack-plugin Documentation', |
| 264 | [author], 1) |
| 265 | ] |
| 266 | |
| 267 | # If true, show URL addresses after external links. |
| 268 | #man_show_urls = False |
| 269 | |
| 270 | |
| 271 | # -- Options for Texinfo output ------------------------------------------- |
| 272 | |
| 273 | # Grouping the document tree into Texinfo files. List of tuples |
| 274 | # (source start file, target name, title, author, |
| 275 | # dir menu entry, description, category) |
| 276 | texinfo_documents = [ |
| 277 | (master_doc, 'cloudify-openstack-plugin', u'cloudify-openstack-plugin Documentation', |
| 278 | author, 'cloudify-openstack-plugin', 'One line description of project.', |
| 279 | 'Miscellaneous'), |
| 280 | ] |
| 281 | |
| 282 | # Documents to append as an appendix to all manuals. |
| 283 | #texinfo_appendices = [] |
| 284 | |
| 285 | # If false, no module index is generated. |
| 286 | #texinfo_domain_indices = True |
| 287 | |
| 288 | # How to display URL addresses: 'footnote', 'no', or 'inline'. |
| 289 | #texinfo_show_urls = 'footnote' |
| 290 | |
| 291 | # If true, do not generate a @detailmenu in the "Top" node's menu. |
| 292 | #texinfo_no_detailmenu = False |
| 293 | |
| 294 | |
| 295 | # Example configuration for intersphinx: refer to the Python standard library. |
| 296 | intersphinx_mapping = {'https://docs.python.org/2/': None} |
| 297 | |
| 298 | |
| 299 | # SCVersioning |
| 300 | scv_show_banner = True |
| 301 | scv_banner_greatest_tag = True |