OpenStack Identity Authentication Library
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 7.4KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237
  1. # -*- coding: utf-8 -*-
  2. #
  3. # keystoneauth1 documentation build configuration file, created by
  4. # sphinx-quickstart on Sun Dec 6 14:19:25 2009.
  5. #
  6. # This file is execfile()d with the current directory set to its containing
  7. # dir.
  8. #
  9. # Note that not all possible configuration values are present in this
  10. # autogenerated file.
  11. #
  12. # All configuration values have a default; values that are commented out
  13. # serve to show the default.
  14. from __future__ import unicode_literals
  15. import os
  16. import subprocess
  17. import sys
  18. import warnings
  19. import pbr.version
  20. sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__),
  21. '..', '..')))
  22. # If extensions (or modules to document with autodoc) are in another directory,
  23. # add these directories to sys.path here. If the directory is relative to the
  24. # documentation root, use os.path.abspath to make it absolute, like shown here.
  25. #sys.path.append(os.path.abspath('.'))
  26. # -- General configuration ----------------------------------------------------
  27. # Add any Sphinx extension module names here, as strings. They can be
  28. # extensions
  29. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  30. extensions = ['sphinx.ext.autodoc',
  31. 'sphinx.ext.todo',
  32. 'sphinx.ext.coverage',
  33. 'sphinx.ext.intersphinx',
  34. 'oslosphinx',
  35. ]
  36. todo_include_todos = True
  37. # Add any paths that contain templates here, relative to this directory.
  38. # templates_path = ['_templates']
  39. # The suffix of source filenames.
  40. source_suffix = '.rst'
  41. # The encoding of source files.
  42. #source_encoding = 'utf-8'
  43. # The master toctree document.
  44. master_doc = 'index'
  45. # General information about the project.
  46. project = 'keystoneauth1'
  47. copyright = 'OpenStack Contributors'
  48. # The version info for the project you're documenting, acts as replacement for
  49. # |version| and |release|, also used in various other places throughout the
  50. # built documents.
  51. version_info = pbr.version.VersionInfo('keystoneauth1')
  52. # The short X.Y version.
  53. version = version_info.version_string()
  54. # The full version, including alpha/beta/rc tags.
  55. release = version_info.release_string()
  56. # The language for content autogenerated by Sphinx. Refer to documentation
  57. # for a list of supported languages.
  58. #language = None
  59. # There are two options for replacing |today|: either, you set today to some
  60. # non-false value, then it is used:
  61. #today = ''
  62. # Else, today_fmt is used as the format for a strftime call.
  63. #today_fmt = '%B %d, %Y'
  64. # List of documents that shouldn't be included in the build.
  65. #unused_docs = []
  66. # List of directories, relative to source directory, that shouldn't be searched
  67. # for source files.
  68. exclude_trees = []
  69. # The reST default role (used for this markup: `text`) to use for all
  70. # documents.
  71. #default_role = None
  72. # If true, '()' will be appended to :func: etc. cross-reference text.
  73. add_function_parentheses = True
  74. # If true, the current module name will be prepended to all description
  75. # unit titles (such as .. function::).
  76. add_module_names = True
  77. # If true, sectionauthor and moduleauthor directives will be shown in the
  78. # output. They are ignored by default.
  79. #show_authors = False
  80. # The name of the Pygments (syntax highlighting) style to use.
  81. pygments_style = 'sphinx'
  82. # A list of ignored prefixes for module index sorting.
  83. modindex_common_prefix = ['keystoneauth1.']
  84. # Grouping the document tree for man pages.
  85. # List of tuples 'sourcefile', 'target', 'title', 'Authors name', 'manual'
  86. #man_pages = []
  87. # -- Options for HTML output --------------------------------------------------
  88. # The theme to use for HTML and HTML Help pages. Major themes that come with
  89. # Sphinx are currently 'default' and 'sphinxdoc'.
  90. #html_theme_path = ["."]
  91. #html_theme = '_theme'
  92. # Theme options are theme-specific and customize the look and feel of a theme
  93. # further. For a list of options available for each theme, see the
  94. # documentation.
  95. #html_theme_options = {}
  96. # Add any paths that contain custom themes here, relative to this directory.
  97. #html_theme_path = []
  98. # The name for this set of Sphinx documents. If None, it defaults to
  99. # "<project> v<release> documentation".
  100. #html_title = None
  101. # A shorter title for the navigation bar. Default is the same as html_title.
  102. #html_short_title = None
  103. # The name of an image file (relative to this directory) to place at the top
  104. # of the sidebar.
  105. #html_logo = None
  106. # The name of an image file (within the static path) to use as favicon of the
  107. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  108. # pixels large.
  109. #html_favicon = None
  110. # Add any paths that contain custom static files (such as style sheets) here,
  111. # relative to this directory. They are copied after the builtin static files,
  112. # so a file named "default.css" will overwrite the builtin "default.css".
  113. #html_static_path = ['static']
  114. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  115. # using the given strftime format.
  116. git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local",
  117. "-n1"]
  118. try:
  119. html_last_updated_fmt = subprocess.Popen(
  120. git_cmd, stdout=subprocess.PIPE).communicate()[0]
  121. except:
  122. warnings.warn('Cannot get last updated time from git repository. '
  123. 'Not setting "html_last_updated_fmt".')
  124. # If true, SmartyPants will be used to convert quotes and dashes to
  125. # typographically correct entities.
  126. #html_use_smartypants = True
  127. # Custom sidebar templates, maps document names to template names.
  128. #html_sidebars = {}
  129. # Additional templates that should be rendered to pages, maps page names to
  130. # template names.
  131. #html_additional_pages = {}
  132. # If false, no module index is generated.
  133. #html_use_modindex = True
  134. # If false, no index is generated.
  135. #html_use_index = True
  136. # If true, the index is split into individual pages for each letter.
  137. #html_split_index = False
  138. # If true, links to the reST sources are added to the pages.
  139. #html_show_sourcelink = True
  140. # If true, an OpenSearch description file will be output, and all pages will
  141. # contain a <link> tag referring to it. The value of this option must be the
  142. # base URL from which the finished HTML is served.
  143. #html_use_opensearch = ''
  144. # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
  145. #html_file_suffix = ''
  146. # Output file base name for HTML help builder.
  147. htmlhelp_basename = 'keystoneauthdoc'
  148. # -- Options for LaTeX output -------------------------------------------------
  149. # The paper size ('letter' or 'a4').
  150. #latex_paper_size = 'letter'
  151. # The font size ('10pt', '11pt' or '12pt').
  152. #latex_font_size = '10pt'
  153. # Grouping the document tree into LaTeX files. List of tuples
  154. # (source start file, target name, title, author, documentclass [howto/manual])
  155. # .
  156. latex_documents = [
  157. ('index', 'keystoneauth1.tex',
  158. 'keystoneauth1 Documentation',
  159. 'Nebula Inc, based on work by Rackspace and Jacob Kaplan-Moss',
  160. 'manual'),
  161. ]
  162. # The name of an image file (relative to this directory) to place at the top of
  163. # the title page.
  164. #latex_logo = None
  165. # For "manual" documents, if this is true, then toplevel headings are parts,
  166. # not chapters.
  167. #latex_use_parts = False
  168. # Additional stuff for the LaTeX preamble.
  169. #latex_preamble = ''
  170. # Documents to append as an appendix to all manuals.
  171. #latex_appendices = []
  172. # If false, no module index is generated.
  173. #latex_use_modindex = True
  174. ksc = 'http://docs.openstack.org/developer/python-keystoneclient/'
  175. intersphinx_mapping = {
  176. 'python': ('http://docs.python.org/', None),
  177. 'osloconfig': ('http://docs.openstack.org/developer/oslo.config/', None),
  178. 'keystoneclient': (ksc, None),
  179. }