"Fossies" - the Fresh Open Source Software Archive

Member "freezer-10.0.0/doc/source/conf.py" (14 Apr 2021, 5632 Bytes) of package /linux/misc/openstack/freezer-10.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: 9.0.0_vs_10.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 # This file is execfile()d with the current directory set
   14 # to its containing dir.
   15 #
   16 # Note that not all possible configuration values are present in this
   17 # autogenerated file.
   18 #
   19 # All configuration values have a default; values that are commented out
   20 # serve to show the default.
   21 
   22 import os
   23 import sys
   24 
   25 # NOTE(dims): monkey patch subprocess to prevent failures in latest eventlet
   26 # See https://github.com/eventlet/eventlet/issues/398
   27 
   28 
   29 # If extensions (or modules to document with autodoc) are in another directory,
   30 # add these directories to sys.path here. If the directory is relative to the
   31 # documentation root, use os.path.abspath to make it absolute, like shown here.
   32 # sys.path.insert(0, os.path.abspath('../../'))
   33 # sys.path.insert(0, os.path.abspath('../'))
   34 # sys.path.insert(0, os.path.abspath('./'))
   35 
   36 # -- General configuration ----------------------------------------------------
   37 
   38 # Add any Sphinx extension module names here, as strings.
   39 # They can be extensions coming with Sphinx (named 'sphinx.ext.*')
   40 # or your custom ones.
   41 
   42 extensions = ['sphinxcontrib.apidoc',
   43               'openstackdocstheme',
   44               'oslo_config.sphinxconfiggen',
   45               'oslo_config.sphinxext'
   46               ]
   47 
   48 config_generator_config_file = (
   49     '../../etc/config-generator.conf')
   50 sample_config_basename = '_static/freezer'
   51 
   52 
   53 # autodoc generation is a bit aggressive and a nuisance
   54 # when doing heavy text edit cycles. Execute "export SPHINX_DEBUG=1"
   55 # in your terminal to disable
   56 #if not os.getenv('SPHINX_DEBUG'):
   57 #    extensions += ['ext.freezer_autodoc']
   58 
   59 todo_include_todos = True
   60 
   61 # sphinxcontrib.apidoc options
   62 apidoc_module_dir = '../../freezer'
   63 apidoc_output_dir = 'reference/api'
   64 apidoc_excluded_paths = [
   65     'scheduler/win*']
   66 apidoc_separate_modules = True
   67 
   68 # Add any paths that contain templates here, relative to this directory.
   69 # templates_path = []
   70 
   71 # The suffix of source filenames.
   72 source_suffix = '.rst'
   73 
   74 # The encoding of source files.
   75 # source_encoding = 'utf-8'
   76 
   77 # The master toctree document.
   78 master_doc = 'index'
   79 
   80 # General information about the project.
   81 openstackdocs_auto_name = False
   82 openstackdocs_repo_name = 'openstack/freezer'
   83 openstackdocs_bug_project = 'freezer'
   84 openstackdocs_bug_tag = 'doc'
   85 project = u'Freezer'
   86 copyright = u'OpenStack Foundation'
   87 
   88 # The version info for the project you're documenting, acts as replacement for
   89 # |version| and |release|, also used in various other places throughout the
   90 # built documents.
   91 #
   92 # from freezer import version_info
   93 # # The full version, including alpha/beta/rc tags.
   94 # release = version_info.release_string()
   95 # # The short X.Y version.
   96 # version = version_info.version_string()
   97 
   98 # The language for content autogenerated by Sphinx. Refer to documentation
   99 # for a list of supported languages.
  100 # language = None
  101 
  102 # There are two options for replacing |today|: either, you set today to some
  103 # non-false value, then it is used:
  104 # today = ''
  105 # Else, today_fmt is used as the format for a strftime call.
  106 # today_fmt = '%B %d, %Y'
  107 
  108 # List of documents that shouldn't be included in the build.
  109 
  110 # # List of directories, relative to source directory, that shouldn't be searched
  111 # # for source files.
  112 # exclude_trees = []
  113 
  114 # A list of glob-style patterns that should be excluded when looking for
  115 # source files. They are matched against the source file names relative to the
  116 # source directory, using slashes as directory separators on all platforms.
  117 exclude_patterns = [
  118     # Missing win32serviceutil module on linux
  119     #'api/freezer.scheduler.win_daemon*',
  120 ]
  121 
  122 #
  123 # # The reST default role (used for this markup: `text`) to use
  124 # # for all documents.
  125 # # default_role = None
  126 #
  127 # # If true, '()' will be appended to :func: etc. cross-reference text.
  128 # # add_function_parentheses = True
  129 #
  130 # # If true, the current module name will be prepended to all description
  131 # # unit titles (such as .. function::).
  132 # add_module_names = False
  133 #
  134 # # If true, sectionauthor and moduleauthor directives will be shown in the
  135 # # output. They are ignored by default.
  136 # show_authors = False
  137 #
  138 # # The name of the Pygments (syntax highlighting) style to use.
  139 # pygments_style = 'sphinx'
  140 
  141 # A list of ignored prefixes for module index sorting.
  142 modindex_common_prefix = ['freezer.']
  143 
  144 # -- Options for man page output ----------------------------------------------
  145 
  146 # Grouping the document tree for man pages.
  147 # List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
  148 
  149 man_pages = [
  150     ('man/freezer-manage', 'freezer-manage', u'Cloud controller fabric',
  151      [u'OpenStack'], 1)
  152 ]
  153 
  154 # -- Options for HTML output --------------------------------------------------
  155 
  156 # If true, '()' will be appended to :func: etc. cross-reference text.
  157 add_function_parentheses = True
  158 
  159 # If true, the current module name will be prepended to all description
  160 # unit titles (such as .. function::).
  161 add_module_names = True
  162 
  163 # The theme to use for HTML and HTML Help pages.  Major themes that come with
  164 # Sphinx are currently 'default' and 'sphinxdoc'.
  165 # html_theme_path = ["."]
  166 html_theme = 'openstackdocs'