OpenStack Image Management (Glance)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

conf.py 9.7KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288
  1. # -*- coding: utf-8 -*-
  2. # Copyright (c) 2010 OpenStack Foundation.
  3. #
  4. # Licensed under the Apache License, Version 2.0 (the "License");
  5. # you may not use this file except in compliance with the License.
  6. # You may obtain a copy of the License at
  7. #
  8. # http://www.apache.org/licenses/LICENSE-2.0
  9. #
  10. # Unless required by applicable law or agreed to in writing, software
  11. # distributed under the License is distributed on an "AS IS" BASIS,
  12. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
  13. # implied.
  14. # See the License for the specific language governing permissions and
  15. # limitations under the License.
  16. #
  17. # Glance documentation build configuration file, created by
  18. # sphinx-quickstart on Tue May 18 13:50:15 2010.
  19. #
  20. # This file is execfile()'d with the current directory set to its containing
  21. # dir.
  22. #
  23. # Note that not all possible configuration values are present in this
  24. # autogenerated file.
  25. #
  26. # All configuration values have a default; values that are commented out
  27. # serve to show the default.
  28. import os
  29. import subprocess
  30. import sys
  31. import warnings
  32. # If extensions (or modules to document with autodoc) are in another directory,
  33. # add these directories to sys.path here. If the directory is relative to the
  34. # documentation root, use os.path.abspath to make it absolute, like shown here.
  35. sys.path = [
  36. os.path.abspath('../..'),
  37. os.path.abspath('../../bin')
  38. ] + sys.path
  39. # -- General configuration ---------------------------------------------------
  40. # Add any Sphinx extension module names here, as strings. They can be
  41. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  42. extensions = ['sphinx.ext.coverage',
  43. 'sphinx.ext.ifconfig',
  44. 'sphinx.ext.graphviz',
  45. 'oslosphinx',
  46. 'stevedore.sphinxext',
  47. 'oslo_config.sphinxext',
  48. 'sphinx.ext.autodoc',
  49. 'sphinx.ext.viewcode',
  50. 'oslo_config.sphinxconfiggen',
  51. ]
  52. config_generator_config_file = [
  53. ('../../etc/oslo-config-generator/glance-api.conf',
  54. '_static/glance-api'),
  55. ('../../etc/oslo-config-generator/glance-cache.conf',
  56. '_static/glance-cache'),
  57. ('../../etc/oslo-config-generator/glance-manage.conf',
  58. '_static/glance-manage'),
  59. ('../../etc/oslo-config-generator/glance-registry.conf',
  60. '_static/glance-registry'),
  61. ('../../etc/oslo-config-generator/glance-scrubber.conf',
  62. '_static/glance-scrubber'),
  63. ]
  64. # Add any paths that contain templates here, relative to this directory.
  65. # templates_path = []
  66. # The suffix of source filenames.
  67. source_suffix = '.rst'
  68. # The encoding of source files.
  69. #source_encoding = 'utf-8'
  70. # The master toctree document.
  71. master_doc = 'index'
  72. # General information about the project.
  73. project = u'Glance'
  74. copyright = u'2010-present, OpenStack Foundation.'
  75. # The version info for the project you're documenting, acts as replacement for
  76. # |version| and |release|, also used in various other places throughout the
  77. # built documents.
  78. #
  79. # The short X.Y version.
  80. from glance.version import version_info as glance_version
  81. # The full version, including alpha/beta/rc tags.
  82. release = glance_version.version_string_with_vcs()
  83. # The short X.Y version.
  84. version = glance_version.canonical_version_string()
  85. # The language for content autogenerated by Sphinx. Refer to documentation
  86. # for a list of supported languages.
  87. #language = None
  88. # There are two options for replacing |today|: either, you set today to some
  89. # non-false value, then it is used:
  90. #today = ''
  91. # Else, today_fmt is used as the format for a strftime call.
  92. #today_fmt = '%B %d, %Y'
  93. # List of documents that shouldn't be included in the build.
  94. #unused_docs = []
  95. # List of directories, relative to source directory, that shouldn't be searched
  96. # for source files.
  97. #exclude_trees = ['api']
  98. exclude_patterns = [
  99. # The man directory includes some snippet files that are included
  100. # in other documents during the build but that should not be
  101. # included in the toctree themselves, so tell Sphinx to ignore
  102. # them when scanning for input files.
  103. 'man/footer.rst',
  104. 'man/general_options.rst',
  105. 'man/openstack_options.rst',
  106. ]
  107. # The reST default role (for this markup: `text`) to use for all documents.
  108. #default_role = None
  109. # If true, '()' will be appended to :func: etc. cross-reference text.
  110. #add_function_parentheses = True
  111. # If true, the current module name will be prepended to all description
  112. # unit titles (such as .. function::).
  113. add_module_names = True
  114. # If true, sectionauthor and moduleauthor directives will be shown in the
  115. # output. They are ignored by default.
  116. show_authors = True
  117. # The name of the Pygments (syntax highlighting) style to use.
  118. pygments_style = 'sphinx'
  119. # A list of ignored prefixes for module index sorting.
  120. modindex_common_prefix = ['glance.']
  121. # -- Options for man page output --------------------------------------------
  122. # Grouping the document tree for man pages.
  123. # List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
  124. man_pages = [
  125. ('man/glanceapi', 'glance-api', u'Glance API Server',
  126. [u'OpenStack'], 1),
  127. ('man/glancecachecleaner', 'glance-cache-cleaner', u'Glance Cache Cleaner',
  128. [u'OpenStack'], 1),
  129. ('man/glancecachemanage', 'glance-cache-manage', u'Glance Cache Manager',
  130. [u'OpenStack'], 1),
  131. ('man/glancecacheprefetcher', 'glance-cache-prefetcher',
  132. u'Glance Cache Pre-fetcher', [u'OpenStack'], 1),
  133. ('man/glancecachepruner', 'glance-cache-pruner', u'Glance Cache Pruner',
  134. [u'OpenStack'], 1),
  135. ('man/glancecontrol', 'glance-control', u'Glance Daemon Control Helper ',
  136. [u'OpenStack'], 1),
  137. ('man/glancemanage', 'glance-manage', u'Glance Management Utility',
  138. [u'OpenStack'], 1),
  139. ('man/glanceregistry', 'glance-registry', u'Glance Registry Server',
  140. [u'OpenStack'], 1),
  141. ('man/glancereplicator', 'glance-replicator', u'Glance Replicator',
  142. [u'OpenStack'], 1),
  143. ('man/glancescrubber', 'glance-scrubber', u'Glance Scrubber Service',
  144. [u'OpenStack'], 1)
  145. ]
  146. # -- Options for HTML output -------------------------------------------------
  147. # The theme to use for HTML and HTML Help pages. Major themes that come with
  148. # Sphinx are currently 'default' and 'sphinxdoc'.
  149. # html_theme_path = ["."]
  150. # html_theme = '_theme'
  151. # Theme options are theme-specific and customize the look and feel of a theme
  152. # further. For a list of options available for each theme, see the
  153. # documentation.
  154. #html_theme_options = {}
  155. # Add any paths that contain custom themes here, relative to this directory.
  156. #html_theme_path = ['_theme']
  157. # The name for this set of Sphinx documents. If None, it defaults to
  158. # "<project> v<release> documentation".
  159. #html_title = None
  160. # A shorter title for the navigation bar. Default is the same as html_title.
  161. #html_short_title = None
  162. # The name of an image file (relative to this directory) to place at the top
  163. # of the sidebar.
  164. #html_logo = None
  165. # The name of an image file (within the static path) to use as favicon of the
  166. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  167. # pixels large.
  168. #html_favicon = None
  169. # Add any paths that contain custom static files (such as style sheets) here,
  170. # relative to this directory. They are copied after the builtin static files,
  171. # so a file named "default.css" will overwrite the builtin "default.css".
  172. html_static_path = ['_static']
  173. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  174. # using the given strftime format.
  175. #html_last_updated_fmt = '%b %d, %Y'
  176. git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local",
  177. "-n1"]
  178. try:
  179. html_last_updated_fmt = subprocess.Popen(
  180. git_cmd, stdout=subprocess.PIPE).communicate()[0]
  181. except Exception:
  182. warnings.warn('Cannot get last updated time from git repository. '
  183. 'Not setting "html_last_updated_fmt".')
  184. # If true, SmartyPants will be used to convert quotes and dashes to
  185. # typographically correct entities.
  186. #html_use_smartypants = True
  187. # Custom sidebar templates, maps document names to template names.
  188. #html_sidebars = {}
  189. # Additional templates that should be rendered to pages, maps page names to
  190. # template names.
  191. #html_additional_pages = {}
  192. # If false, no module index is generated.
  193. html_use_modindex = True
  194. # If false, no index is generated.
  195. html_use_index = True
  196. # If true, the index is split into individual pages for each letter.
  197. #html_split_index = False
  198. # If true, links to the reST sources are added to the pages.
  199. #html_show_sourcelink = True
  200. # If true, an OpenSearch description file will be output, and all pages will
  201. # contain a <link> tag referring to it. The value of this option must be the
  202. # base URL from which the finished HTML is served.
  203. #html_use_opensearch = ''
  204. # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
  205. #html_file_suffix = ''
  206. # Output file base name for HTML help builder.
  207. htmlhelp_basename = 'glancedoc'
  208. # -- Options for LaTeX output ------------------------------------------------
  209. # The paper size ('letter' or 'a4').
  210. #latex_paper_size = 'letter'
  211. # The font size ('10pt', '11pt' or '12pt').
  212. #latex_font_size = '10pt'
  213. # Grouping the document tree into LaTeX files. List of tuples
  214. # (source start file, target name, title, author,
  215. # documentclass [howto/manual]).
  216. latex_documents = [
  217. ('index', 'Glance.tex', u'Glance Documentation',
  218. u'Glance Team', 'manual'),
  219. ]
  220. # The name of an image file (relative to this directory) to place at the top of
  221. # the title page.
  222. #latex_logo = None
  223. # For "manual" documents, if this is true, then toplevel headings are parts,
  224. # not chapters.
  225. #latex_use_parts = False
  226. # Additional stuff for the LaTeX preamble.
  227. #latex_preamble = ''
  228. # Documents to append as an appendix to all manuals.
  229. #latex_appendices = []
  230. # If false, no module index is generated.
  231. #latex_use_modindex = True