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.3KB

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