"Fossies" - the Fresh Open Source Software Archive

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