"Fossies" - the Fresh Open Source Software Archive

Member "keystone-18.0.0/releasenotes/source/conf.py" (14 Oct 2020, 8953 Bytes) of package /linux/misc/openstack/keystone-18.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: 17.0.0_vs_18.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 # Keystone Release Notes documentation build configuration file, created by
   15 # sphinx-quickstart on Tue Nov  3 17:40:50 2015.
   16 #
   17 # This file is execfile()d with the current directory set to its
   18 # containing dir.
   19 #
   20 # Note that not all possible configuration values are present in this
   21 # autogenerated file.
   22 #
   23 # All configuration values have a default; values that are commented out
   24 # serve to show the default.
   25 
   26 # If extensions (or modules to document with autodoc) are in another directory,
   27 # add these directories to sys.path here. If the directory is relative to the
   28 # documentation root, use os.path.abspath to make it absolute, like shown here.
   29 # sys.path.insert(0, os.path.abspath('.'))
   30 
   31 # -- General configuration ------------------------------------------------
   32 
   33 # If your documentation needs a minimal Sphinx version, state it here.
   34 # needs_sphinx = '1.0'
   35 
   36 # Add any Sphinx extension module names here, as strings. They can be
   37 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
   38 # ones.
   39 extensions = [
   40     'openstackdocstheme',
   41     'reno.sphinxext',
   42 ]
   43 
   44 # Add any paths that contain templates here, relative to this directory.
   45 templates_path = ['_templates']
   46 
   47 # The suffix of source filenames.
   48 source_suffix = '.rst'
   49 
   50 # The encoding of source files.
   51 # source_encoding = 'utf-8-sig'
   52 
   53 # The master toctree document.
   54 master_doc = 'index'
   55 
   56 # General information about the project.
   57 project = u'Keystone Release Notes'
   58 copyright = u'2015, Keystone Developers'
   59 
   60 # Release  notes are version independent
   61 
   62 # The full version, including alpha/beta/rc tags.
   63 
   64 release = ''
   65 # The short X.Y version.
   66 version = ''
   67 
   68 # The language for content autogenerated by Sphinx. Refer to documentation
   69 # for a list of supported languages.
   70 # language = None
   71 
   72 # There are two options for replacing |today|: either, you set today to some
   73 # non-false value, then it is used:
   74 # today = ''
   75 # Else, today_fmt is used as the format for a strftime call.
   76 # today_fmt = '%B %d, %Y'
   77 
   78 # List of patterns, relative to source directory, that match files and
   79 # directories to ignore when looking for source files.
   80 exclude_patterns = []
   81 
   82 # The reST default role (used for this markup: `text`) to use for all
   83 # documents.
   84 # default_role = None
   85 
   86 # If true, '()' will be appended to :func: etc. cross-reference text.
   87 # add_function_parentheses = True
   88 
   89 # If true, the current module name will be prepended to all description
   90 # unit titles (such as .. function::).
   91 # add_module_names = True
   92 
   93 # If true, sectionauthor and moduleauthor directives will be shown in the
   94 # output. They are ignored by default.
   95 # show_authors = False
   96 
   97 # The name of the Pygments (syntax highlighting) style to use.
   98 pygments_style = 'native'
   99 
  100 # A list of ignored prefixes for module index sorting.
  101 # modindex_common_prefix = []
  102 
  103 # If true, keep warnings as "system message" paragraphs in the built documents.
  104 # keep_warnings = False
  105 
  106 
  107 # -- Options for HTML output ----------------------------------------------
  108 
  109 # The theme to use for HTML and HTML Help pages.  See the documentation for
  110 # a list of builtin themes.
  111 html_theme = 'openstackdocs'
  112 
  113 # Theme options are theme-specific and customize the look and feel of a theme
  114 # further.  For a list of options available for each theme, see the
  115 # documentation.
  116 # html_theme_options = {}
  117 
  118 # Add any paths that contain custom themes here, relative to this directory.
  119 # html_theme_path = []
  120 
  121 # The name for this set of Sphinx documents.  If None, it defaults to
  122 # "<project> v<release> documentation".
  123 # html_title = None
  124 
  125 # A shorter title for the navigation bar.  Default is the same as html_title.
  126 # html_short_title = None
  127 
  128 # The name of an image file (relative to this directory) to place at the top
  129 # of the sidebar.
  130 # html_logo = None
  131 
  132 # The name of an image file (within the static path) to use as favicon of the
  133 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
  134 # pixels large.
  135 # html_favicon = None
  136 
  137 # Add any paths that contain custom static files (such as style sheets) here,
  138 # relative to this directory. They are copied after the builtin static files,
  139 # so a file named "default.css" will overwrite the builtin "default.css".
  140 html_static_path = ['_static']
  141 
  142 # Add any extra paths that contain custom files (such as robots.txt or
  143 # .htaccess) here, relative to this directory. These files are copied
  144 # directly to the root of the documentation.
  145 # html_extra_path = []
  146 
  147 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  148 # using the given strftime format.
  149 # html_last_updated_fmt = '%b %d, %Y'
  150 # html_last_updated_fmt = '%Y-%m-%d %H:%M'
  151 
  152 # If true, SmartyPants will be used to convert quotes and dashes to
  153 # typographically correct entities.
  154 # html_use_smartypants = True
  155 
  156 # Custom sidebar templates, maps document names to template names.
  157 # html_sidebars = {}
  158 
  159 # Additional templates that should be rendered to pages, maps page names to
  160 # template names.
  161 # html_additional_pages = {}
  162 
  163 # If false, no module index is generated.
  164 # html_domain_indices = True
  165 
  166 # If false, no index is generated.
  167 # html_use_index = True
  168 
  169 # If true, the index is split into individual pages for each letter.
  170 # html_split_index = False
  171 
  172 # If true, links to the reST sources are added to the pages.
  173 # html_show_sourcelink = True
  174 
  175 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  176 # html_show_sphinx = True
  177 
  178 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  179 # html_show_copyright = True
  180 
  181 # If true, an OpenSearch description file will be output, and all pages will
  182 # contain a <link> tag referring to it.  The value of this option must be the
  183 # base URL from which the finished HTML is served.
  184 # html_use_opensearch = ''
  185 
  186 # This is the file name suffix for HTML files (e.g. ".xhtml").
  187 # html_file_suffix = None
  188 
  189 # Output file base name for HTML help builder.
  190 htmlhelp_basename = 'KeystoneReleaseNotesdoc'
  191 
  192 
  193 # -- Options for LaTeX output ---------------------------------------------
  194 
  195 # Grouping the document tree into LaTeX files. List of tuples
  196 # (source start file, target name, title,
  197 #  author, documentclass [howto, manual, or own class]).
  198 latex_documents = [
  199     ('index', 'KeystoneReleaseNotes.tex',
  200      u'Keystone Release Notes Documentation',
  201      u'Keystone Developers', 'manual'),
  202 ]
  203 
  204 # The name of an image file (relative to this directory) to place at the top of
  205 # the title page.
  206 # latex_logo = None
  207 
  208 # For "manual" documents, if this is true, then toplevel headings are parts,
  209 # not chapters.
  210 # latex_use_parts = False
  211 
  212 # If true, show page references after internal links.
  213 # latex_show_pagerefs = False
  214 
  215 # If true, show URL addresses after external links.
  216 # latex_show_urls = False
  217 
  218 # Documents to append as an appendix to all manuals.
  219 # latex_appendices = []
  220 
  221 # If false, no module index is generated.
  222 # latex_domain_indices = True
  223 
  224 
  225 # -- Options for manual page output ---------------------------------------
  226 
  227 # One entry per manual page. List of tuples
  228 # (source start file, name, description, authors, manual section).
  229 man_pages = [
  230     ('index', 'keystonereleasenotes', u'Keystone Release Notes Documentation',
  231      [u'Keystone Developers'], 1)
  232 ]
  233 
  234 # If true, show URL addresses after external links.
  235 # man_show_urls = False
  236 
  237 
  238 # -- Options for Texinfo output -------------------------------------------
  239 
  240 # Grouping the document tree into Texinfo files. List of tuples
  241 # (source start file, target name, title, author,
  242 #  dir menu entry, description, category)
  243 texinfo_documents = [
  244     ('index', 'KeystoneReleaseNotes', u'Keystone Release Notes Documentation',
  245      u'Keystone Developers', 'KeystoneReleaseNotes',
  246      'Identity, Authentication and Access Management for OpenStack.',
  247      'Miscellaneous'),
  248 ]
  249 
  250 # Documents to append as an appendix to all manuals.
  251 # texinfo_appendices = []
  252 
  253 # If false, no module index is generated.
  254 # texinfo_domain_indices = True
  255 
  256 # How to display URL addresses: 'footnote', 'no', or 'inline'.
  257 # texinfo_show_urls = 'footnote'
  258 
  259 # If true, do not generate a @detailmenu in the "Top" node's menu.
  260 # texinfo_no_detailmenu = False
  261 
  262 # -- Options for Internationalization output ------------------------------
  263 locale_dirs = ['locale/']
  264 
  265 # -- Options for openstackdocstheme -------------------------------------------
  266 openstackdocs_auto_name = False
  267 openstackdocs_repo_name = 'openstack/keystone'
  268 openstackdocs_bug_project = 'keystone'
  269 openstackdocs_bug_tag = 'doc'