"Fossies" - the Fresh Open Source Software Archive

Member "monasca-api-4.0.0/releasenotes/source/conf.py" (13 May 2020, 6942 Bytes) of package /linux/misc/openstack/monasca-api-4.0.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.1.0_vs_4.0.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 # -- General configuration ------------------------------------------------
   15 
   16 # If your documentation needs a minimal Sphinx version, state it here.
   17 needs_sphinx = '1.6'
   18 
   19 # Add any Sphinx extension module names here, as strings. They can be
   20 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
   21 # ones.
   22 extensions = [
   23     'openstackdocstheme',
   24     'reno.sphinxext'
   25 ]
   26 
   27 # Add any paths that contain templates here, relative to this directory.
   28 templates_path = ['_templates']
   29 
   30 # The suffix of source filenames.
   31 source_suffix = '.rst'
   32 
   33 # The encoding of source files.
   34 source_encoding = 'utf-8'
   35 
   36 # The master toctree document.
   37 master_doc = 'index'
   38 
   39 # General information about the project.
   40 repository_name = u'openstack/monasca-api'
   41 
   42 # Release notes do not need a version number in the title, they
   43 # cover multiple releases.
   44 version = ''
   45 release = ''
   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 # Theme options are theme-specific and customize the look and feel of a theme
   97 # further.  For a list of options available for each theme, see the
   98 # documentation.
   99 # html_theme_options = {}
  100 
  101 # Add any paths that contain custom themes here, relative to this directory.
  102 # html_theme_path = []
  103 
  104 # The name for this set of Sphinx documents.  If None, it defaults to
  105 # "<project> v<release> documentation".
  106 # html_title = None
  107 
  108 # A shorter title for the navigation bar.  Default is the same as html_title.
  109 # html_short_title = None
  110 
  111 # The name of an image file (relative to this directory) to place at the top
  112 # of the sidebar.
  113 # html_logo = None
  114 
  115 # The name of an image file (within the static path) to use as favicon of the
  116 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
  117 # pixels large.
  118 # html_favicon = None
  119 
  120 # Add any paths that contain custom static files (such as style sheets) here,
  121 # relative to this directory. They are copied after the builtin static files,
  122 # so a file named "default.css" will overwrite the builtin "default.css".
  123 # html_static_path = []
  124 
  125 # Add any extra paths that contain custom files (such as robots.txt or
  126 # .htaccess) here, relative to this directory. These files are copied
  127 # directly to the root of the documentation.
  128 # html_extra_path = []
  129 
  130 # If true, SmartyPants will be used to convert quotes and dashes to
  131 # typographically correct entities.
  132 # html_use_smartypants = True
  133 
  134 # Custom sidebar templates, maps document names to template names.
  135 # html_sidebars = {}
  136 
  137 # Additional templates that should be rendered to pages, maps page names to
  138 # template names.
  139 # html_additional_pages = {}
  140 
  141 # If false, no module index is generated.
  142 # html_domain_indices = True
  143 
  144 # If false, no index is generated.
  145 # html_use_index = True
  146 
  147 # If true, the index is split into individual pages for each letter.
  148 # html_split_index = False
  149 
  150 # If true, links to the reST sources are added to the pages.
  151 # html_show_sourcelink = True
  152 
  153 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  154 # html_show_sphinx = True
  155 
  156 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  157 # html_show_copyright = True
  158 
  159 # If true, an OpenSearch description file will be output, and all pages will
  160 # contain a <link> tag referring to it.  The value of this option must be the
  161 # base URL from which the finished HTML is served.
  162 # html_use_opensearch = ''
  163 
  164 # This is the file name suffix for HTML files (e.g. ".xhtml").
  165 # html_file_suffix = None
  166 
  167 # Output file base name for HTML help builder.
  168 htmlhelp_basename = 'MonitoringApiReleaseNotesDoc'
  169 
  170 # -- Options for LaTeX output ---------------------------------------------
  171 
  172 # Grouping the document tree into LaTeX files. List of tuples
  173 # (source start file, target name, title,
  174 #  author, documentclass [howto, manual, or own class]).
  175 latex_documents = [(
  176     master_doc, 'MonitoringApiReleaseNotes.tex',
  177     u'Monitoring API Release Notes', [author],
  178     'manual'
  179 )]
  180 
  181 # The name of an image file (relative to this directory) to place at the top of
  182 # the title page.
  183 # latex_logo = None
  184 
  185 # For "manual" documents, if this is true, then toplevel headings are parts,
  186 # not chapters.
  187 # latex_use_parts = False
  188 
  189 # If true, show page references after internal links.
  190 # latex_show_pagerefs = False
  191 
  192 # If true, show URL addresses after external links.
  193 # latex_show_urls = False
  194 
  195 # Documents to append as an appendix to all manuals.
  196 # latex_appendices = []
  197 
  198 # If false, no module index is generated.
  199 # latex_domain_indices = True
  200 
  201 
  202 # -- Options for manual page output ---------------------------------------
  203 
  204 # One entry per manual page. List of tuples
  205 # (source start file, name, description, authors, manual section).
  206 man_pages = [
  207     (master_doc, 'monitoringapireleasenotes',
  208      u'Monitoring API Release Notes', [author],
  209      1)
  210 ]
  211 
  212 # -- Options for Internationalization output ------------------------------
  213 locale_dirs = ['locale/']