"Fossies" - the Fresh Open Source Software Archive

Member "keystone-18.0.0/api-ref/source/conf.py" (14 Oct 2020, 6364 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"); you may
    2 # not use this file except in compliance with the License. You may obtain
    3 # 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, WITHOUT
    9 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
   10 # License for the specific language governing permissions and limitations
   11 # under the License.
   12 #
   13 # keystone documentation build configuration file, created by
   14 # sphinx-quickstart on Mon May 23 07:54:13 2016.
   15 #
   16 # This file is execfile()d with the current directory set to its
   17 # containing dir.
   18 #
   19 # Note that not all possible configuration values are present in this
   20 # autogenerated file.
   21 #
   22 # All configuration values have a default; values that are commented out
   23 # serve to show the default.
   24 
   25 html_theme = 'openstackdocs'
   26 html_theme_options = {
   27     "sidebar_dropdown": "api_ref",
   28     "sidebar_mode": "toc",
   29 }
   30 
   31 extensions = [
   32     'os_api_ref',
   33     'openstackdocstheme',
   34 ]
   35 
   36 
   37 # If extensions (or modules to document with autodoc) are in another directory,
   38 # add these directories to sys.path here. If the directory is relative to the
   39 # documentation root, use os.path.abspath to make it absolute, like shown here.
   40 # sys.path.insert(0, os.path.abspath('.'))
   41 
   42 # -- General configuration ------------------------------------------------
   43 
   44 # If your documentation needs a minimal Sphinx version, state it here.
   45 # needs_sphinx = '1.0'
   46 
   47 # Add any Sphinx extension module names here, as strings. They can be
   48 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
   49 # ones.[]
   50 
   51 # Add any paths that contain templates here, relative to this directory.
   52 # templates_path = ['_templates']
   53 
   54 # The suffix of source filenames.
   55 source_suffix = '.rst'
   56 
   57 # The encoding of source files.
   58 # source_encoding = 'utf-8'
   59 
   60 # The master toctree document.
   61 master_doc = 'index'
   62 
   63 # General information about the project.
   64 copyright = u'2010-present, OpenStack Foundation'
   65 
   66 # -- Options for openstackdocstheme -------------------------------------------
   67 openstackdocs_repo_name = 'openstack/keystone'
   68 openstackdocs_bug_project = 'keystone'
   69 openstackdocs_bug_tag = 'api-ref'
   70 
   71 # The language for content autogenerated by Sphinx. Refer to documentation
   72 # for a list of supported languages.
   73 # language = None
   74 
   75 # There are two options for replacing |today|: either, you set today to some
   76 # non-false value, then it is used:
   77 # today = ''
   78 # Else, today_fmt is used as the format for a strftime call.
   79 # today_fmt = '%B %d, %Y'
   80 
   81 # List of patterns, relative to source directory, that match files and
   82 # directories to ignore when looking for source files.
   83 # exclude_patterns = []
   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 = False
   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 = 'native'
  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 
  110 # -- Options for HTML output ----------------------------------------------
  111 
  112 # The theme to use for HTML and HTML Help pages.  See the documentation for
  113 # a list of builtin themes.
  114 # html_theme = 'default'
  115 
  116 # Theme options are theme-specific and customize the look and feel of a theme
  117 # further.  For a list of options available for each theme, see the
  118 # documentation.
  119 # html_theme_options = {}
  120 
  121 # Add any paths that contain custom themes here, relative to this directory.
  122 # html_theme_path = []
  123 
  124 # The name for this set of Sphinx documents.  If None, it defaults to
  125 # "<project> v<release> documentation".
  126 # html_title = None
  127 
  128 # A shorter title for the navigation bar.  Default is the same as html_title.
  129 # html_short_title = None
  130 
  131 # The name of an image file (relative to this directory) to place at the top
  132 # of the sidebar.
  133 # html_logo = None
  134 
  135 # The name of an image file (within the static path) to use as favicon of the
  136 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
  137 # pixels large.
  138 # html_favicon = None
  139 
  140 # Add any paths that contain custom static files (such as style sheets) here,
  141 # relative to this directory. They are copied after the builtin static files,
  142 # so a file named "default.css" will overwrite the builtin "default.css".
  143 # html_static_path = ['_static']
  144 
  145 # Add any extra paths that contain custom files (such as robots.txt or
  146 # .htaccess) here, relative to this directory. These files are copied
  147 # directly to the root of the documentation.
  148 # html_extra_path = []
  149 
  150 # If true, SmartyPants will be used to convert quotes and dashes to
  151 # typographically correct entities.
  152 # html_use_smartypants = True
  153 
  154 # Custom sidebar templates, maps document names to template names.
  155 # html_sidebars = {}
  156 
  157 # Additional templates that should be rendered to pages, maps page names to
  158 # template names.
  159 # html_additional_pages = {}
  160 
  161 # If false, no module index is generated.
  162 # html_domain_indices = True
  163 
  164 # If false, no index is generated.
  165 # html_use_index = True
  166 
  167 # If true, the index is split into individual pages for each letter.
  168 # html_split_index = False
  169 
  170 # If true, links to the reST sources are added to the pages.
  171 # html_show_sourcelink = True
  172 
  173 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  174 # html_show_sphinx = True
  175 
  176 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  177 # html_show_copyright = True
  178 
  179 # If true, an OpenSearch description file will be output, and all pages will
  180 # contain a <link> tag referring to it.  The value of this option must be the
  181 # base URL from which the finished HTML is served.
  182 # html_use_opensearch = ''
  183 
  184 # This is the file name suffix for HTML files (e.g. ".xhtml").
  185 # html_file_suffix = None
  186 
  187 # Output file base name for HTML help builder.
  188 htmlhelp_basename = 'keystonedoc'