"Fossies" - the Fresh Open Source Software Archive

Member "aodh-15.0.0/doc/source/conf.py" (5 Oct 2022, 9923 Bytes) of package /linux/misc/openstack/aodh-15.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: 14.0.0_vs_15.0.0.

    1 #
    2 # Aodh documentation build configuration file, created by
    3 # sphinx-quickstart on Thu Oct 27 11:38:59 2011.
    4 #
    5 # This file is execfile()d with the current directory set to its
    6 # containing dir.
    7 #
    8 # Note that not all possible configuration values are present in this
    9 # autogenerated file.
   10 #
   11 # All configuration values have a default; values that are commented out
   12 # serve to show the default.
   13 
   14 import sys
   15 import os
   16 
   17 BASE_DIR = os.path.dirname(os.path.abspath(__file__))
   18 ROOT = os.path.abspath(os.path.join(BASE_DIR, "..", ".."))
   19 
   20 sys.path.insert(0, ROOT)
   21 sys.path.insert(0, BASE_DIR)
   22 
   23 # This is required for ReadTheDocs.org, but isn't a bad idea anyway.
   24 os.environ['DJANGO_SETTINGS_MODULE'] = 'openstack_dashboard.settings'
   25 
   26 
   27 # If extensions (or modules to document with autodoc) are in another directory,
   28 # add these directories to sys.path here. If the directory is relative to the
   29 # documentation root, use os.path.abspath to make it absolute, like shown here.
   30 #sys.path.insert(0, os.path.abspath('.'))
   31 
   32 # -- General configuration ----------------------------------------------------
   33 
   34 # If your documentation needs a minimal Sphinx version, state it here.
   35 #needs_sphinx = '1.0'
   36 
   37 # Add any Sphinx extension module names here, as strings.
   38 # They can be extensions coming with Sphinx (named 'sphinx.ext.*')
   39 # or your custom ones.
   40 extensions = [
   41     'openstackdocstheme',
   42     'sphinx.ext.autodoc',
   43     'wsmeext.sphinxext',
   44     'sphinx.ext.coverage',
   45     'sphinx.ext.viewcode',
   46     'sphinxcontrib.pecanwsme.rest',
   47     'stevedore.sphinxext',
   48     'oslo_config.sphinxconfiggen',
   49     'oslo_config.sphinxext',
   50     'oslo_policy.sphinxpolicygen',
   51     'oslo_policy.sphinxext',
   52     'sphinxcontrib.httpdomain',
   53 ]
   54 
   55 config_generator_config_file = os.path.join(ROOT,
   56                                             'aodh/cmd/aodh-config-generator.conf')
   57 sample_config_basename = '_static/aodh'
   58 
   59 policy_generator_config_file = (
   60     '../../aodh/cmd/aodh-policy-generator.conf'
   61 )
   62 sample_policy_basename = '_static/aodh'
   63 
   64 wsme_protocols = ['restjson', 'restxml']
   65 
   66 todo_include_todos = True
   67 
   68 # The suffix of source filenames.
   69 source_suffix = '.rst'
   70 
   71 # The encoding of source files.
   72 #source_encoding = 'utf-8-sig'
   73 
   74 # The master toctree document.
   75 master_doc = 'index'
   76 
   77 # General information about the project.
   78 copyright = '2012-2015, OpenStack Foundation'
   79 
   80 # The language for content autogenerated by Sphinx. Refer to documentation
   81 # for a list of supported languages.
   82 #language = None
   83 
   84 # There are two options for replacing |today|: either, you set today to some
   85 # non-false value, then it is used:
   86 #today = ''
   87 # Else, today_fmt is used as the format for a strftime call.
   88 #today_fmt = '%B %d, %Y'
   89 
   90 # List of patterns, relative to source directory, that match files and
   91 # directories to ignore when looking for source files.
   92 exclude_patterns = ['**/#*', '**~', '**/#*#', '**/*alembic*']
   93 
   94 # The reST default role (used for this markup: `text`)
   95 # to use for all documents.
   96 #default_role = None
   97 
   98 # If true, '()' will be appended to :func: etc. cross-reference text.
   99 #add_function_parentheses = True
  100 
  101 # If true, the current module name will be prepended to all description
  102 # unit titles (such as .. function::).
  103 #add_module_names = True
  104 
  105 # If true, sectionauthor and moduleauthor directives will be shown in the
  106 # output. They are ignored by default.
  107 show_authors = False
  108 
  109 # The name of the Pygments (syntax highlighting) style to use.
  110 pygments_style = 'native'
  111 
  112 # A list of ignored prefixes for module index sorting.
  113 #modindex_common_prefix = []
  114 
  115 primary_domain = 'py'
  116 nitpicky = False
  117 
  118 # -- Options for HTML output --------------------------------------------------
  119 
  120 # The theme to use for HTML and HTML Help pages.  See the documentation for
  121 # a list of builtin themes.
  122 # html_theme_path = ['.']
  123 html_theme = 'openstackdocs'
  124 
  125 # Add any paths that contain custom themes here, relative to this directory.
  126 # html_theme_path = [openstackdocstheme.get_html_theme_path()]
  127 
  128 # The name for this set of Sphinx documents.  If None, it defaults to
  129 # "<project> v<release> documentation".
  130 #html_title = None
  131 
  132 # A shorter title for the navigation bar.  Default is the same as html_title.
  133 #html_short_title = None
  134 
  135 # The name of an image file (relative to this directory) to place at the top
  136 # of the sidebar.
  137 #html_logo = None
  138 
  139 # The name of an image file (within the static path) to use as favicon of the
  140 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
  141 # pixels large.
  142 #html_favicon = None
  143 
  144 # Add any paths that contain custom static files (such as style sheets) here,
  145 # relative to this directory. They are copied after the builtin static files,
  146 # so a file named "default.css" will overwrite the builtin "default.css".
  147 html_static_path = ['_static']
  148 
  149 # openstackdocstheme options
  150 openstackdocs_repo_name = 'openstack/aodh'
  151 openstackdocs_pdf_link = True
  152 openstackdocs_bug_project = 'aodh'
  153 openstackdocs_bug_tag = ''
  154 
  155 # If true, SmartyPants will be used to convert quotes and dashes to
  156 # typographically correct entities.
  157 #html_use_smartypants = True
  158 
  159 # Custom sidebar templates, maps document names to template names.
  160 #html_sidebars = {}
  161 
  162 # Additional templates that should be rendered to pages, maps page names to
  163 # template names.
  164 #html_additional_pages = {}
  165 
  166 # If false, no module index is generated.
  167 #html_domain_indices = True
  168 
  169 # If false, no index is generated.
  170 #html_use_index = True
  171 
  172 # If true, the index is split into individual pages for each letter.
  173 #html_split_index = False
  174 
  175 # If true, links to the reST sources are added to the pages.
  176 #html_show_sourcelink = True
  177 
  178 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  179 #html_show_sphinx = True
  180 
  181 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  182 #html_show_copyright = True
  183 
  184 # If true, an OpenSearch description file will be output, and all pages will
  185 # contain a <link> tag referring to it.  The value of this option must be the
  186 # base URL from which the finished HTML is served.
  187 #html_use_opensearch = ''
  188 
  189 # This is the file name suffix for HTML files (e.g. ".xhtml").
  190 #html_file_suffix = None
  191 
  192 # Output file base name for HTML help builder.
  193 htmlhelp_basename = 'Aodhdoc'
  194 
  195 
  196 # -- Options for LaTeX output -------------------------------------------------
  197 
  198 # Grouping the document tree into LaTeX files. List of tuples
  199 # (source start file, target name, title, author, documentclass
  200 # [howto/manual]).
  201 latex_documents = [
  202     ('index', 'doc-aodh.tex', 'Aodh Documentation',
  203      'OpenStack Foundation', 'manual'),
  204 ]
  205 
  206 latex_elements = {
  207     'makeindex': '',
  208     'printindex': '',
  209     'preamble': r'\setcounter{tocdepth}{3}',
  210     'maxlistdepth': '10',
  211 }
  212 
  213 # Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664
  214 latex_use_xindy = False
  215 
  216 # Disable smartquotes, they don't work in latex
  217 smartquotes_excludes = {'builders': ['latex']}
  218 
  219 latex_domain_indices = False
  220 
  221 # The name of an image file (relative to this directory) to place at the top of
  222 # the title page.
  223 #latex_logo = None
  224 
  225 # For "manual" documents, if this is true, then toplevel headings are parts,
  226 # not chapters.
  227 #latex_use_parts = False
  228 
  229 # If true, show page references after internal links.
  230 #latex_show_pagerefs = False
  231 
  232 # If true, show URL addresses after external links.
  233 #latex_show_urls = False
  234 
  235 # Documents to append as an appendix to all manuals.
  236 #latex_appendices = []
  237 
  238 # If false, no module index is generated.
  239 #latex_domain_indices = True
  240 
  241 
  242 # -- Options for manual page output -------------------------------------------
  243 
  244 # One entry per manual page. List of tuples
  245 # (source start file, name, description, authors, manual section).
  246 man_pages = [
  247     ('index', 'aodh', 'Aodh Documentation',
  248      ['OpenStack'], 1)
  249 ]
  250 
  251 # If true, show URL addresses after external links.
  252 #man_show_urls = False
  253 
  254 
  255 # -- Options for Texinfo output -----------------------------------------------
  256 
  257 # Grouping the document tree into Texinfo files. List of tuples
  258 # (source start file, target name, title, author,
  259 #  dir menu entry, description, category)
  260 texinfo_documents = [
  261     ('index', 'Aodh', 'Aodh Documentation', 'OpenStack',
  262      'Aodh', 'One line description of project.', '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 # -- Options for Epub output --------------------------------------------------
  276 
  277 # Bibliographic Dublin Core info.
  278 epub_title = 'Aodh'
  279 epub_author = 'OpenStack'
  280 epub_publisher = 'OpenStack'
  281 epub_copyright = '2012-2015, OpenStack'
  282 
  283 # The language of the text. It defaults to the language option
  284 # or en if the language is not set.
  285 #epub_language = ''
  286 
  287 # The scheme of the identifier. Typical schemes are ISBN or URL.
  288 #epub_scheme = ''
  289 
  290 # The unique identifier of the text. This can be an ISBN number
  291 # or the project homepage.
  292 #epub_identifier = ''
  293 
  294 # A unique identification for the text.
  295 #epub_uid = ''
  296 
  297 # A tuple containing the cover image and cover page html template filenames.
  298 #epub_cover = ()
  299 
  300 # HTML files that should be inserted before the pages created by sphinx.
  301 # The format is a list of tuples containing the path and title.
  302 #epub_pre_files = []
  303 
  304 # HTML files shat should be inserted after the pages created by sphinx.
  305 # The format is a list of tuples containing the path and title.
  306 #epub_post_files = []
  307 
  308 # A list of files that should not be packed into the epub file.
  309 #epub_exclude_files = []
  310 
  311 # The depth of the table of contents in toc.ncx.
  312 #epub_tocdepth = 3
  313 
  314 # Allow duplicate toc entries.
  315 #epub_tocdup = True
  316 
  317 # NOTE(dhellmann): pbr used to set this option but now that we are
  318 # using Sphinx>=1.6.2 it does not so we have to set it ourselves.
  319 suppress_warnings = [
  320     'app.add_directive', 'app.add_role',
  321     'app.add_generic_role', 'app.add_node',
  322     'image.nonlocal_uri',
  323 ]