"Fossies" - the Fresh Open Source Software Archive

Member "keystone-18.0.0/doc/source/conf.py" (14 Oct 2020, 9087 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 #
   15 # keystone documentation build configuration file, created by
   16 # sphinx-quickstart on Mon Jan  9 12:02:59 2012.
   17 #
   18 # This file is execfile()d with the current directory set to its
   19 #  containing dir.
   20 #
   21 # Note that not all possible configuration values are present in this
   22 # autogenerated file.
   23 #
   24 # All configuration values have a default; values that are commented out
   25 # serve to show the default.
   26 
   27 # -- General configuration ----------------------------------------------------
   28 
   29 # If your documentation needs a minimal Sphinx version, state it here.
   30 # needs_sphinx = '1.0'
   31 
   32 # Add any Sphinx extension module names here, as strings. They can be
   33 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
   34 # ones.
   35 extensions = ['sphinx.ext.coverage',
   36               'sphinx.ext.viewcode',
   37               'oslo_config.sphinxconfiggen',
   38               'oslo_config.sphinxext',
   39               'oslo_policy.sphinxpolicygen',
   40               'openstackdocstheme',
   41               'oslo_policy.sphinxext',
   42               'sphinxcontrib.apidoc',
   43               'sphinxcontrib.seqdiag',
   44               'sphinx_feature_classification.support_matrix',
   45               'sphinxcontrib.blockdiag'
   46               ]
   47 
   48 blockdiag_html_image_format = 'SVG'
   49 
   50 blockdiag_fontpath = 'DejaVuSans.ttf'
   51 
   52 # sphinxcontrib.apidoc options
   53 apidoc_module_dir = '../../keystone'
   54 apidoc_output_dir = 'api'
   55 apidoc_excluded_paths = [
   56     'tests/*',
   57     'tests',
   58     'test']
   59 apidoc_separate_modules = True
   60 
   61 # sphinxcontrib.seqdiag options
   62 seqdiag_antialias = True
   63 seqdiag_html_image_format = 'SVG'
   64 
   65 config_generator_config_file = '../../config-generator/keystone.conf'
   66 sample_config_basename = '_static/keystone'
   67 
   68 policy_generator_config_file = (
   69     '../../config-generator/keystone-policy-generator.conf'
   70 )
   71 sample_policy_basename = '_static/keystone'
   72 
   73 todo_include_todos = True
   74 
   75 # The suffix of source filenames.
   76 source_suffix = '.rst'
   77 
   78 # The encoding of source files.
   79 # source_encoding = 'utf-8-sig'
   80 
   81 # The master toctree document.
   82 master_doc = 'index'
   83 
   84 # General information about the project.
   85 copyright = u'2012, OpenStack Foundation'
   86 
   87 # The language for content autogenerated by Sphinx. Refer to documentation
   88 # for a list of supported languages.
   89 # language = None
   90 
   91 # There are two options for replacing |today|: either, you set today to some
   92 # non-false value, then it is used:
   93 # today = ''
   94 # Else, today_fmt is used as the format for a strftime call.
   95 # today_fmt = '%B %d, %Y'
   96 
   97 # List of patterns, relative to source directory, that match files and
   98 # directories to ignore when looking for source files.
   99 exclude_patterns = ['old']
  100 
  101 # The reST default role (used for this markup: `text`) to use for all
  102 # documents.
  103 # default_role = None
  104 
  105 # If true, '()' will be appended to :func: etc. cross-reference text.
  106 # add_function_parentheses = True
  107 
  108 # If true, the current module name will be prepended to all description
  109 # unit titles (such as .. function::).
  110 # add_module_names = True
  111 
  112 # If true, sectionauthor and moduleauthor directives will be shown in the
  113 # output. They are ignored by default.
  114 show_authors = True
  115 
  116 # The name of the Pygments (syntax highlighting) style to use.
  117 pygments_style = 'native'
  118 
  119 # A list of ignored prefixes for module index sorting.
  120 modindex_common_prefix = ['keystone.']
  121 
  122 # -- Options for man page output --------------------------------------------
  123 
  124 # Grouping the document tree for man pages.
  125 # List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
  126 
  127 man_pages = [
  128     ('cli/keystone-manage', 'keystone-manage', u'Keystone Management Utility',
  129      [u'OpenStack'], 1)
  130 ]
  131 
  132 
  133 # -- Options for HTML output --------------------------------------------------
  134 
  135 # The theme to use for HTML and HTML Help pages.  See the documentation for
  136 # a list of builtin themes.
  137 html_theme = 'openstackdocs'
  138 
  139 # Theme options are theme-specific and customize the look and feel of a theme
  140 # further.  For a list of options available for each theme, see the
  141 # documentation.
  142 # html_theme_options = {}
  143 
  144 # Add any paths that contain custom themes here, relative to this directory.
  145 # html_theme_path = []
  146 
  147 # The name for this set of Sphinx documents.  If None, it defaults to
  148 # "<project> v<release> documentation".
  149 # html_title = None
  150 
  151 # A shorter title for the navigation bar.  Default is the same as html_title.
  152 # html_short_title = None
  153 
  154 # The name of an image file (relative to this directory) to place at the top
  155 # of the sidebar.
  156 # html_logo = None
  157 
  158 # The name of an image file (within the static path) to use as favicon of the
  159 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
  160 # pixels large.
  161 # html_favicon = None
  162 
  163 # Add any paths that contain custom static files (such as style sheets) here,
  164 # relative to this directory. They are copied after the builtin static files,
  165 # so a file named "default.css" will overwrite the builtin "default.css".
  166 html_static_path = ['_static']
  167 
  168 # If true, SmartyPants will be used to convert quotes and dashes to
  169 # typographically correct entities.
  170 # html_use_smartypants = True
  171 
  172 # Custom sidebar templates, maps document names to template names.
  173 # html_sidebars = {}
  174 
  175 # Additional templates that should be rendered to pages, maps page names to
  176 # template names.
  177 # html_additional_pages = {}
  178 
  179 # If false, no module index is generated.
  180 # html_domain_indices = True
  181 
  182 # If false, no index is generated.
  183 # html_use_index = True
  184 
  185 # If true, the index is split into individual pages for each letter.
  186 # html_split_index = False
  187 
  188 # If true, links to the reST sources are added to the pages.
  189 # html_show_sourcelink = True
  190 
  191 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  192 # html_show_sphinx = True
  193 
  194 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  195 # html_show_copyright = True
  196 
  197 # If true, an OpenSearch description file will be output, and all pages will
  198 # contain a <link> tag referring to it.  The value of this option must be the
  199 # base URL from which the finished HTML is served.
  200 # html_use_opensearch = ''
  201 
  202 # This is the file name suffix for HTML files (e.g. ".xhtml").
  203 # html_file_suffix = None
  204 
  205 # Output file base name for HTML help builder.
  206 htmlhelp_basename = 'keystonedoc'
  207 
  208 
  209 # -- Options for LaTeX output -------------------------------------------------
  210 
  211 # Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664
  212 latex_use_xindy = False
  213 
  214 latex_domain_indices = False
  215 
  216 latex_elements = {
  217     'makeindex': '',
  218     'printindex': '',
  219     'preamble': r'\setcounter{tocdepth}{3}',
  220     'maxlistdepth': 10,
  221 }
  222 
  223 # Grouping the document tree into LaTeX files. List of tuples (source
  224 # start file, target name, title, author, documentclass
  225 # [howto/manual]).
  226 # NOTE(gyee): Specify toctree_only=True for a better document structure of
  227 # the generated PDF file.
  228 latex_documents = [
  229     ('index', 'doc-keystone.tex', u'Keystone Documentation',
  230      u'OpenStack', 'manual', True)
  231 ]
  232 
  233 # The name of an image file (relative to this directory) to place at the top of
  234 # the title page.
  235 # latex_logo = None
  236 
  237 # For "manual" documents, if this is true, then toplevel headings are parts,
  238 # not chapters.
  239 # latex_use_parts = False
  240 
  241 # If true, show page references after internal links.
  242 # latex_show_pagerefs = False
  243 
  244 # If true, show URL addresses after external links.
  245 # latex_show_urls = False
  246 
  247 # Documents to append as an appendix to all manuals.
  248 # latex_appendices = []
  249 
  250 # If false, no module index is generated.
  251 # latex_domain_indices = True
  252 
  253 
  254 # -- Options for Texinfo output -----------------------------------------------
  255 
  256 # Grouping the document tree into Texinfo files. List of tuples
  257 # (source start file, target name, title, author,
  258 #  dir menu entry, description, category)
  259 texinfo_documents = [
  260     ('index', 'keystone', u'Keystone Documentation',
  261      u'OpenStack', 'keystone', 'One line description of project.',
  262      'Miscellaneous'),
  263 ]
  264 
  265 # Documents to append as an appendix to all manuals.
  266 # texinfo_appendices = []
  267 
  268 # If false, no module index is generated.
  269 # texinfo_domain_indices = True
  270 
  271 # How to display URL addresses: 'footnote', 'no', or 'inline'.
  272 # texinfo_show_urls = 'footnote'
  273 
  274 
  275 # Example configuration for intersphinx: refer to the Python standard library.
  276 # intersphinx_mapping = {'http://docs.python.org/': None}
  277 
  278 # -- Options for openstackdocstheme -------------------------------------------
  279 openstackdocs_repo_name = 'openstack/keystone'
  280 openstackdocs_bug_project = 'keystone'
  281 openstackdocs_bug_tag = 'documentation'
  282 openstackdocs_projects = ['python-openstackclient']
  283 openstackdocs_pdf_link = True