OpenStack Identity (Keystone)
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 8.7KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279
  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. # keystone documentation build configuration file, created by
  15. # sphinx-quickstart on Mon Jan 9 12:02:59 2012.
  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. # -- General configuration ----------------------------------------------------
  26. # If your documentation needs a minimal Sphinx version, state it here.
  27. # needs_sphinx = '1.0'
  28. # Add any Sphinx extension module names here, as strings. They can be
  29. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  30. # ones.
  31. extensions = ['sphinx.ext.coverage',
  32. 'sphinx.ext.viewcode',
  33. 'oslo_config.sphinxconfiggen',
  34. 'oslo_config.sphinxext',
  35. 'oslo_policy.sphinxpolicygen',
  36. 'openstackdocstheme',
  37. 'oslo_policy.sphinxext',
  38. 'sphinxcontrib.apidoc',
  39. 'sphinxcontrib.seqdiag',
  40. 'sphinx_feature_classification.support_matrix',
  41. ]
  42. # sphinxcontrib.apidoc options
  43. apidoc_module_dir = '../../keystone'
  44. apidoc_output_dir = 'api'
  45. apidoc_excluded_paths = [
  46. 'tests/*',
  47. 'tests',
  48. 'test']
  49. apidoc_separate_modules = True
  50. # sphinxcontrib.seqdiag options
  51. seqdiag_antialias = True
  52. seqdiag_html_image_format = 'SVG'
  53. config_generator_config_file = '../../config-generator/keystone.conf'
  54. sample_config_basename = '_static/keystone'
  55. policy_generator_config_file = (
  56. '../../config-generator/keystone-policy-generator.conf'
  57. )
  58. sample_policy_basename = '_static/keystone'
  59. todo_include_todos = True
  60. # The suffix of source filenames.
  61. source_suffix = '.rst'
  62. # The encoding of source files.
  63. # source_encoding = 'utf-8-sig'
  64. # The master toctree document.
  65. master_doc = 'index'
  66. # General information about the project.
  67. project = u'keystone'
  68. copyright = u'2012, OpenStack Foundation'
  69. # The language for content autogenerated by Sphinx. Refer to documentation
  70. # for a list of supported languages.
  71. # language = None
  72. # There are two options for replacing |today|: either, you set today to some
  73. # non-false value, then it is used:
  74. # today = ''
  75. # Else, today_fmt is used as the format for a strftime call.
  76. # today_fmt = '%B %d, %Y'
  77. # List of patterns, relative to source directory, that match files and
  78. # directories to ignore when looking for source files.
  79. exclude_patterns = ['old']
  80. # The reST default role (used for this markup: `text`) to use for all
  81. # documents.
  82. # default_role = None
  83. # If true, '()' will be appended to :func: etc. cross-reference text.
  84. # add_function_parentheses = True
  85. # If true, the current module name will be prepended to all description
  86. # unit titles (such as .. function::).
  87. # add_module_names = True
  88. # If true, sectionauthor and moduleauthor directives will be shown in the
  89. # output. They are ignored by default.
  90. show_authors = True
  91. # The name of the Pygments (syntax highlighting) style to use.
  92. pygments_style = 'sphinx'
  93. # A list of ignored prefixes for module index sorting.
  94. modindex_common_prefix = ['keystone.']
  95. # -- Options for man page output --------------------------------------------
  96. # Grouping the document tree for man pages.
  97. # List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
  98. man_pages = [
  99. ('cli/keystone-manage', 'keystone-manage', u'Keystone Management Utility',
  100. [u'OpenStack'], 1)
  101. ]
  102. # -- Options for HTML output --------------------------------------------------
  103. # The theme to use for HTML and HTML Help pages. See the documentation for
  104. # a list of builtin themes.
  105. html_theme = 'openstackdocs'
  106. # Theme options are theme-specific and customize the look and feel of a theme
  107. # further. For a list of options available for each theme, see the
  108. # documentation.
  109. # html_theme_options = {}
  110. # Add any paths that contain custom themes here, relative to this directory.
  111. # html_theme_path = []
  112. # The name for this set of Sphinx documents. If None, it defaults to
  113. # "<project> v<release> documentation".
  114. # html_title = None
  115. # A shorter title for the navigation bar. Default is the same as html_title.
  116. # html_short_title = None
  117. # The name of an image file (relative to this directory) to place at the top
  118. # of the sidebar.
  119. # html_logo = None
  120. # The name of an image file (within the static path) to use as favicon of the
  121. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  122. # pixels large.
  123. # html_favicon = None
  124. # Add any paths that contain custom static files (such as style sheets) here,
  125. # relative to this directory. They are copied after the builtin static files,
  126. # so a file named "default.css" will overwrite the builtin "default.css".
  127. html_static_path = ['_static']
  128. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  129. # using the given strftime format.
  130. # html_last_updated_fmt = '%b %d, %Y'
  131. html_last_updated_fmt = '%Y-%m-%d %H:%M'
  132. # If true, SmartyPants will be used to convert quotes and dashes to
  133. # typographically correct entities.
  134. # html_use_smartypants = True
  135. # Custom sidebar templates, maps document names to template names.
  136. # html_sidebars = {}
  137. # Additional templates that should be rendered to pages, maps page names to
  138. # template names.
  139. # html_additional_pages = {}
  140. # If false, no module index is generated.
  141. # html_domain_indices = True
  142. # If false, no index is generated.
  143. # html_use_index = True
  144. # If true, the index is split into individual pages for each letter.
  145. # html_split_index = False
  146. # If true, links to the reST sources are added to the pages.
  147. # html_show_sourcelink = True
  148. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  149. # html_show_sphinx = True
  150. # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  151. # html_show_copyright = True
  152. # If true, an OpenSearch description file will be output, and all pages will
  153. # contain a <link> tag referring to it. The value of this option must be the
  154. # base URL from which the finished HTML is served.
  155. # html_use_opensearch = ''
  156. # This is the file name suffix for HTML files (e.g. ".xhtml").
  157. # html_file_suffix = None
  158. # Output file base name for HTML help builder.
  159. htmlhelp_basename = 'keystonedoc'
  160. # -- Options for LaTeX output -------------------------------------------------
  161. latex_elements = {
  162. # The paper size ('letterpaper' or 'a4paper').
  163. # 'papersize': 'letterpaper',
  164. # The font size ('10pt', '11pt' or '12pt').
  165. # 'pointsize': '10pt',
  166. # Additional stuff for the LaTeX preamble.
  167. # 'preamble': '',
  168. }
  169. # Grouping the document tree into LaTeX files. List of tuples (source
  170. # start file, target name, title, author, documentclass
  171. # [howto/manual]).
  172. latex_documents = [
  173. ('index', 'keystone.tex', u'Keystone Documentation',
  174. u'OpenStack', 'manual'),
  175. ]
  176. # The name of an image file (relative to this directory) to place at the top of
  177. # the title page.
  178. # latex_logo = None
  179. # For "manual" documents, if this is true, then toplevel headings are parts,
  180. # not chapters.
  181. # latex_use_parts = False
  182. # If true, show page references after internal links.
  183. # latex_show_pagerefs = False
  184. # If true, show URL addresses after external links.
  185. # latex_show_urls = False
  186. # Documents to append as an appendix to all manuals.
  187. # latex_appendices = []
  188. # If false, no module index is generated.
  189. # latex_domain_indices = True
  190. # -- Options for Texinfo output -----------------------------------------------
  191. # Grouping the document tree into Texinfo files. List of tuples
  192. # (source start file, target name, title, author,
  193. # dir menu entry, description, category)
  194. texinfo_documents = [
  195. ('index', 'keystone', u'Keystone Documentation',
  196. u'OpenStack', 'keystone', 'One line description of project.',
  197. 'Miscellaneous'),
  198. ]
  199. # Documents to append as an appendix to all manuals.
  200. # texinfo_appendices = []
  201. # If false, no module index is generated.
  202. # texinfo_domain_indices = True
  203. # How to display URL addresses: 'footnote', 'no', or 'inline'.
  204. # texinfo_show_urls = 'footnote'
  205. # Example configuration for intersphinx: refer to the Python standard library.
  206. # intersphinx_mapping = {'http://docs.python.org/': None}
  207. # -- Options for openstackdocstheme -------------------------------------------
  208. repository_name = 'openstack/keystone'
  209. bug_project = 'keystone'
  210. bug_tag = 'documentation'