"Fossies" - the Fresh Open Source Software Archive

Member "monasca-api-3.1.0/api-ref/source/conf.py" (27 Sep 2019, 6589 Bytes) of package /linux/misc/openstack/monasca-api-3.1.0.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) Python source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. For more information about "conf.py" see the Fossies "Dox" file reference documentation and the latest Fossies "Diffs" side-by-side code changes report: 3.0.0_vs_3.1.0.

    1 # Licensed under the Apache License, Version 2.0 (the "License");
    2 # you may not use this file except in compliance with the License.
    3 # You may obtain a copy of the License at
    4 #
    5 #    http://www.apache.org/licenses/LICENSE-2.0
    6 #
    7 # Unless required by applicable law or agreed to in writing, software
    8 # distributed under the License is distributed on an "AS IS" BASIS,
    9 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
   10 # implied.
   11 # See the License for the specific language governing permissions and
   12 # limitations under the License.
   13 #
   14 # Key Manager API documentation build configuration file
   15 #
   16 # All configuration values have a default; values that are commented out
   17 # serve to show the default.
   18 
   19 # -- General configuration ------------------------------------------------
   20 
   21 # If your documentation needs a minimal Sphinx version, state it here.
   22 needs_sphinx = '1.6'
   23 
   24 # Add any Sphinx extension module names here, as strings. They can be
   25 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
   26 # ones.
   27 extensions = [
   28     'os_api_ref',
   29     'openstackdocstheme'
   30 ]
   31 
   32 # Add any paths that contain templates here, relative to this directory.
   33 templates_path = ['_templates']
   34 
   35 # The suffix of source filenames.
   36 source_suffix = '.rst'
   37 
   38 # The encoding of source files.
   39 source_encoding = 'utf-8'
   40 
   41 # The master toctree document.
   42 master_doc = 'index'
   43 
   44 # General details about project
   45 repository_name = u'openstack/monasca-api'
   46 bug_project = u'863'
   47 bug_tag = u''
   48 copyright = u'2014-present, OpenStack Foundation'
   49 author = u'OpenStack Foundation'
   50 
   51 # The language for content autogenerated by Sphinx. Refer to documentation
   52 # for a list of supported languages.
   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 exclude_patterns = []
   64 
   65 # The reST default role (used for this markup: `text`) to use for all
   66 # documents.
   67 # default_role = None
   68 
   69 # If true, '()' will be appended to :func: etc. cross-reference text.
   70 # add_function_parentheses = True
   71 
   72 # If true, the current module name will be prepended to all description
   73 # unit titles (such as .. function::).
   74 # add_module_names = True
   75 
   76 # If true, sectionauthor and moduleauthor directives will be shown in the
   77 # output. They are ignored by default.
   78 # show_authors = False
   79 
   80 # The name of the Pygments (syntax highlighting) style to use.
   81 pygments_style = 'sphinx'
   82 
   83 # A list of ignored prefixes for module index sorting.
   84 # modindex_common_prefix = []
   85 
   86 # If true, keep warnings as "system message" paragraphs in the built documents.
   87 # keep_warnings = False
   88 
   89 
   90 # -- Options for HTML output ----------------------------------------------
   91 
   92 # The theme to use for HTML and HTML Help pages.  See the documentation for
   93 # a list of builtin themes.
   94 html_theme = 'openstackdocs'
   95 
   96 # To use the API Reference sidebar dropdown menu,
   97 # uncomment the html_theme_options parameter.  The theme
   98 # variable, sidebar_dropdown, should be set to `api_ref`.
   99 # Otherwise, the list of links for the User and Ops docs
  100 # appear in the sidebar dropdown menu.
  101 html_theme_options = {"sidebar_dropdown": "api_ref",
  102                       "sidebar_mode": "toc"}
  103 
  104 # A shorter title for the navigation bar.  Default is the same as html_title.
  105 html_short_title = 'API Ref'
  106 
  107 # The name of an image file (relative to this directory) to place at the top
  108 # of the sidebar.
  109 # html_logo = None
  110 
  111 # The name of an image file (within the static path) to use as favicon of the
  112 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
  113 # pixels large.
  114 # html_favicon = None
  115 
  116 # Add any paths that contain custom static files (such as style sheets) here,
  117 # relative to this directory. They are copied after the builtin static files,
  118 # so a file named "default.css" will overwrite the builtin "default.css".
  119 # html_static_path = []
  120 
  121 # Add any extra paths that contain custom files (such as robots.txt or
  122 # .htaccess) here, relative to this directory. These files are copied
  123 # directly to the root of the documentation.
  124 # html_extra_path = []
  125 
  126 # If true, SmartyPants will be used to convert quotes and dashes to
  127 # typographically correct entities.
  128 # html_use_smartypants = True
  129 
  130 # Custom sidebar templates, maps document names to template names.
  131 # html_sidebars = {}
  132 
  133 # Additional templates that should be rendered to pages, maps page names to
  134 # template names.
  135 # html_additional_pages = {}
  136 
  137 # If false, no module index is generated.
  138 # html_domain_indices = True
  139 
  140 # If false, no index is generated.
  141 html_use_index = True
  142 
  143 # If true, the index is split into individual pages for each letter.
  144 # html_split_index = False
  145 
  146 # If true, links to the reST sources are added to the pages.
  147 # html_show_sourcelink = True
  148 
  149 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  150 # html_show_sphinx = True
  151 
  152 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  153 # html_show_copyright = True
  154 
  155 # If true, an OpenSearch description file will be output, and all pages will
  156 # contain a <link> tag referring to it.  The value of this option must be the
  157 # base URL from which the finished HTML is served.
  158 # html_use_opensearch = ''
  159 
  160 # This is the file name suffix for HTML files (e.g. ".xhtml").
  161 # html_file_suffix = None
  162 
  163 # Output file base name for HTML help builder.
  164 htmlhelp_basename = 'MonitoringApiRefDoc'
  165 
  166 # -- Options for LaTeX output ---------------------------------------------
  167 
  168 # Grouping the document tree into LaTeX files. List of tuples
  169 # (source start file, target name, title,
  170 #  author, documentclass [howto, manual, or own class]).
  171 latex_documents = [
  172     (master_doc, 'MonitoringApiRef.tex', u'Monitoring Service API Reference',
  173      [author], 'manual'),
  174 ]
  175 
  176 # The name of an image file (relative to this directory) to place at the top of
  177 # the title page.
  178 # latex_logo = None
  179 
  180 # For "manual" documents, if this is true, then toplevel headings are parts,
  181 # not chapters.
  182 # latex_use_parts = False
  183 
  184 # If true, show page references after internal links.
  185 # latex_show_pagerefs = False
  186 
  187 # If true, show URL addresses after external links.
  188 # latex_show_urls = False
  189 
  190 # Documents to append as an appendix to all manuals.
  191 # latex_appendices = []
  192 
  193 # If false, no module index is generated.
  194 # latex_domain_indices = True
  195 
  196 # -- Options for Internationalization output ------------------------------
  197 locale_dirs = ['locale/']