Artifact Repository (Glare) Specifications
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.5KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276
  1. # -*- coding: utf-8 -*-
  2. #
  3. # Tempest documentation build configuration file, created by
  4. # sphinx-quickstart on Tue May 21 17:43:32 2013.
  5. #
  6. # This file is execfile()d with the current directory set to its containing dir.
  7. #
  8. # Note that not all possible configuration values are present in this
  9. # autogenerated file.
  10. #
  11. # All configuration values have a default; values that are commented out
  12. # serve to show the default.
  13. import datetime
  14. import subprocess
  15. import sys
  16. import os
  17. # If extensions (or modules to document with autodoc) are in another directory,
  18. # add these directories to sys.path here. If the directory is relative to the
  19. # documentation root, use os.path.abspath to make it absolute, like shown here.
  20. sys.path.insert(0, os.path.abspath('.'))
  21. on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
  22. # -- General configuration -----------------------------------------------------
  23. # If your documentation needs a minimal Sphinx version, state it here.
  24. #needs_sphinx = '1.0'
  25. # Add any Sphinx extension module names here, as strings. They can be extensions
  26. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  27. extensions = ['redirect',
  28. 'sphinx.ext.autodoc',
  29. 'sphinx.ext.todo',
  30. 'sphinx.ext.viewcode',
  31. 'yasfb',
  32. ]
  33. # Feed configuration for yasfb
  34. feed_base_url = 'http://glare-specs.readthedocs.org'
  35. feed_author = 'OpenStack Glare Team'
  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-sig'
  43. # The master toctree document.
  44. master_doc = 'index'
  45. # General information about the project.
  46. project = u'Glare Specs'
  47. copyright = u'%s, OpenStack Glare Team' % datetime.date.today().year
  48. # The language for content autogenerated by Sphinx. Refer to documentation
  49. # for a list of supported languages.
  50. #language = None
  51. # There are two options for replacing |today|: either, you set today to some
  52. # non-false value, then it is used:
  53. #today = ''
  54. # Else, today_fmt is used as the format for a strftime call.
  55. #today_fmt = '%B %d, %Y'
  56. # List of patterns, relative to source directory, that match files and
  57. # directories to ignore when looking for source files.
  58. exclude_patterns = [
  59. '_build',
  60. '**/template.rst',
  61. ]
  62. # The reST default role (used for this markup: `text`) to use for all documents.
  63. #default_role = None
  64. # If true, '()' will be appended to :func: etc. cross-reference text.
  65. #add_function_parentheses = True
  66. # If true, the current module name will be prepended to all description
  67. # unit titles (such as .. function::).
  68. add_module_names = False
  69. # If true, sectionauthor and moduleauthor directives will be shown in the
  70. # output. They are ignored by default.
  71. show_authors = False
  72. # The name of the Pygments (syntax highlighting) style to use.
  73. pygments_style = 'sphinx'
  74. # A list of ignored prefixes for module index sorting.
  75. modindex_common_prefix = ['glare-specs.']
  76. # -- Options for man page output ----------------------------------------------
  77. man_pages = []
  78. # -- Options for HTML output ---------------------------------------------------
  79. # Theme options are theme-specific and customize the look and feel of a theme
  80. # further. For a list of options available for each theme, see the
  81. # documentation.
  82. #html_theme_options = {}
  83. # Add any paths that contain custom themes here, relative to this directory.
  84. #html_theme_path = []
  85. # The name for this set of Sphinx documents. If None, it defaults to
  86. # "<project> v<release> documentation".
  87. #html_title = None
  88. # A shorter title for the navigation bar. Default is the same as html_title.
  89. #html_short_title = None
  90. # The name of an image file (relative to this directory) to place at the top
  91. # of the sidebar.
  92. #html_logo = None
  93. # The name of an image file (within the static path) to use as favicon of the
  94. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  95. # pixels large.
  96. #html_favicon = None
  97. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  98. # using the given strftime format.
  99. git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local",
  100. "-n1"]
  101. html_last_updated_fmt = subprocess.Popen(
  102. git_cmd, stdout=subprocess.PIPE).communicate()[0]
  103. # If true, SmartyPants will be used to convert quotes and dashes to
  104. # typographically correct entities.
  105. #html_use_smartypants = True
  106. # Custom sidebar templates, maps document names to template names.
  107. #html_sidebars = {}
  108. # Additional templates that should be rendered to pages, maps page names to
  109. # template names.
  110. #html_additional_pages = {}
  111. # If false, no module index is generated.
  112. html_domain_indices = False
  113. # If false, no index is generated.
  114. html_use_index = False
  115. # If true, the index is split into individual pages for each letter.
  116. #html_split_index = False
  117. # If true, links to the reST sources are added to the pages.
  118. #html_show_sourcelink = True
  119. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  120. #html_show_sphinx = True
  121. # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  122. #html_show_copyright = True
  123. # If true, an OpenSearch description file will be output, and all pages will
  124. # contain a <link> tag referring to it. The value of this option must be the
  125. # base URL from which the finished HTML is served.
  126. #html_use_opensearch = ''
  127. # This is the file name suffix for HTML files (e.g. ".xhtml").
  128. #html_file_suffix = None
  129. # Output file base name for HTML help builder.
  130. htmlhelp_basename = 'Glare-Specsdoc'
  131. # -- Options for LaTeX output --------------------------------------------------
  132. latex_elements = {
  133. # The paper size ('letterpaper' or 'a4paper').
  134. #'papersize': 'letterpaper',
  135. # The font size ('10pt', '11pt' or '12pt').
  136. #'pointsize': '10pt',
  137. # Additional stuff for the LaTeX preamble.
  138. #'preamble': '',
  139. }
  140. # Grouping the document tree into LaTeX files. List of tuples
  141. # (source start file, target name, title, author, documentclass [howto/manual]).
  142. latex_documents = [
  143. ('index', 'Glare-specs.tex', u'Glare Specs',
  144. u'OpenStack Glare Team', 'manual'),
  145. ]
  146. # The name of an image file (relative to this directory) to place at the top of
  147. # the title page.
  148. #latex_logo = None
  149. # For "manual" documents, if this is true, then toplevel headings are parts,
  150. # not chapters.
  151. #latex_use_parts = False
  152. # If true, show page references after internal links.
  153. #latex_show_pagerefs = False
  154. # If true, show URL addresses after external links.
  155. #latex_show_urls = False
  156. # Documents to append as an appendix to all manuals.
  157. #latex_appendices = []
  158. # If false, no module index is generated.
  159. #latex_domain_indices = True
  160. # -- Options for Texinfo output ------------------------------------------------
  161. # Grouping the document tree into Texinfo files. List of tuples
  162. # (source start file, target name, title, author,
  163. # dir menu entry, description, category)
  164. texinfo_documents = [
  165. ('index', 'Glare-specs', u'Glare Design Specs',
  166. u'OpenStack Glare Team', 'glare-specs', 'Design specifications for the Glare project.',
  167. 'Miscellaneous'),
  168. ]
  169. # Documents to append as an appendix to all manuals.
  170. #texinfo_appendices = []
  171. # If false, no module index is generated.
  172. #texinfo_domain_indices = True
  173. # How to display URL addresses: 'footnote', 'no', or 'inline'.
  174. #texinfo_show_urls = 'footnote'
  175. # -- Options for Epub output ---------------------------------------------------
  176. # Bibliographic Dublin Core info.
  177. epub_title = u'Glare Specs'
  178. epub_author = u'OpenStack Glare Team'
  179. epub_publisher = u'OpenStack Glare Team'
  180. epub_copyright = u'2014, OpenStack Glare Team'
  181. # The language of the text. It defaults to the language option
  182. # or en if the language is not set.
  183. #epub_language = ''
  184. # The scheme of the identifier. Typical schemes are ISBN or URL.
  185. #epub_scheme = ''
  186. # The unique identifier of the text. This can be a ISBN number
  187. # or the project homepage.
  188. #epub_identifier = ''
  189. # A unique identification for the text.
  190. #epub_uid = ''
  191. # A tuple containing the cover image and cover page html template filenames.
  192. #epub_cover = ()
  193. # HTML files that should be inserted before the pages created by sphinx.
  194. # The format is a list of tuples containing the path and title.
  195. #epub_pre_files = []
  196. # HTML files shat should be inserted after the pages created by sphinx.
  197. # The format is a list of tuples containing the path and title.
  198. #epub_post_files = []
  199. # A list of files that should not be packed into the epub file.
  200. #epub_exclude_files = []
  201. # The depth of the table of contents in toc.ncx.
  202. #epub_tocdepth = 3
  203. # Allow duplicate toc entries.
  204. #epub_tocdup = True