| 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 |
# Blazar API reference build configuration file, created by |
| 15 |
# sphinx-quickstart on Mon Oct 2 14:47:19 2017. |
| 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 |
|
| 30 |
extensions = [ |
| 31 |
'os_api_ref', |
| 32 |
'openstackdocstheme' |
| 33 |
] |
| 34 |
|
| 35 |
html_theme = 'openstackdocs' |
| 36 |
html_theme_options = { |
| 37 |
"sidebar_mode": "toc", |
| 38 |
} |
| 39 |
|
| 40 |
# openstackdocstheme options |
| 41 |
openstackdocs_repo_name = 'openstack/blazar' |
| 42 |
openstackdocs_bug_project = 'blazar' |
| 43 |
openstackdocs_bug_tag = 'api-ref' |
| 44 |
|
| 45 |
# -- General configuration ------------------------------------------------ |
| 46 |
|
| 47 |
# Add any paths that contain templates here, relative to this directory. |
| 48 |
templates_path = ['_templates'] |
| 49 |
|
| 50 |
# The suffix(es) of source filenames. |
| 51 |
# You can specify multiple suffix as a list of string: |
| 52 |
# |
| 53 |
# source_suffix = ['.rst', '.md'] |
| 54 |
source_suffix = '.rst' |
| 55 |
|
| 56 |
# The master toctree document. |
| 57 |
master_doc = 'index' |
| 58 |
|
| 59 |
# General information about the project. |
| 60 |
copyright = '2017-present, OpenStack Foundation' |
| 61 |
author = 'OpenStack Foundation' |
| 62 |
|
| 63 |
# The language for content autogenerated by Sphinx. Refer to documentation |
| 64 |
# for a list of supported languages. |
| 65 |
# |
| 66 |
# This is also used if you do content translation via gettext catalogs. |
| 67 |
# Usually you set "language" from the command line for these cases. |
| 68 |
#language = None |
| 69 |
|
| 70 |
# List of patterns, relative to source directory, that match files and |
| 71 |
# directories to ignore when looking for source files. |
| 72 |
# This patterns also effect to html_static_path and html_extra_path |
| 73 |
exclude_patterns = [] |
| 74 |
|
| 75 |
# The name of the Pygments (syntax highlighting) style to use. |
| 76 |
pygments_style = 'native' |
| 77 |
|
| 78 |
# If true, `todo` and `todoList` produce output, else they produce nothing. |
| 79 |
todo_include_todos = False |
| 80 |
|
| 81 |
|
| 82 |
# -- Options for HTML output ---------------------------------------------- |
| 83 |
|
| 84 |
# The theme to use for HTML and HTML Help pages. See the documentation for |
| 85 |
# a list of builtin themes. |
| 86 |
# |
| 87 |
# html_theme = 'alabaster' |
| 88 |
|
| 89 |
# Theme options are theme-specific and customize the look and feel of a theme |
| 90 |
# further. For a list of options available for each theme, see the |
| 91 |
# documentation. |
| 92 |
# |
| 93 |
# html_theme_options = {} |
| 94 |
|
| 95 |
# Add any paths that contain custom static files (such as style sheets) here, |
| 96 |
# relative to this directory. They are copied after the builtin static files, |
| 97 |
# so a file named "default.css" will overwrite the builtin "default.css". |
| 98 |
# html_static_path = ['_static'] |
| 99 |
|
| 100 |
|
| 101 |
# -- Options for HTMLHelp output ------------------------------------------ |
| 102 |
|
| 103 |
# Output file base name for HTML help builder. |
| 104 |
htmlhelp_basename = 'blazardoc' |
| 105 |
|
| 106 |
|
| 107 |
# -- Options for LaTeX output --------------------------------------------- |
| 108 |
|
| 109 |
# Grouping the document tree into LaTeX files. List of tuples |
| 110 |
# (source start file, target name, title, |
| 111 |
# author, documentclass [howto, manual, or own class]). |
| 112 |
latex_documents = [ |
| 113 |
(master_doc, 'ReservationAPIReference.tex', 'OpenStack Reservation API Reference Documentation', |
| 114 |
'OpenStack Foundation', 'manual'), |
| 115 |
] |