Tools used by OpenStack Documentation
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.

280 lines
9.1KB

  1. # -*- coding: utf-8 -*-
  2. # Licensed under the Apache License, Version 2.0 (the "License");
  3. # you may not use this file except in compliance with the License.
  4. # You may obtain a copy of the License at
  5. #
  6. # http://www.apache.org/licenses/LICENSE-2.0
  7. #
  8. # Unless required by applicable law or agreed to in writing, software
  9. # distributed under the License is distributed on an "AS IS" BASIS,
  10. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
  11. # implied.
  12. # See the License for the specific language governing permissions and
  13. # limitations under the License.
  14. # This file is execfile()d with the current directory set to its
  15. # containing dir.
  16. #
  17. # Note that not all possible configuration values are present in this
  18. # autogenerated file.
  19. #
  20. # All configuration values have a default; values that are commented out
  21. # serve to show the default.
  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.insert(0, os.path.abspath('.'))
  26. # -- General configuration ------------------------------------------------
  27. # If your documentation needs a minimal Sphinx version, state it here.
  28. # needs_sphinx = '1.0'
  29. # Add any Sphinx extension module names here, as strings. They can be
  30. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  31. # ones.
  32. extensions = [
  33. 'openstackdocstheme',
  34. 'reno.sphinxext',
  35. ]
  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-sig'
  42. # The master toctree document.
  43. master_doc = 'index'
  44. # General information about the project.
  45. repository_name = 'openstack/openstack-doc-tools'
  46. bug_tag = u'openstack-doc-tools'
  47. project = u'OpenStack-doc-tools Release Notes'
  48. copyright = u'2015-2017, OpenStack Documentation team'
  49. # The version info for the project you're documenting, acts as replacement for
  50. # |version| and |release|, also used in various other places throughout the
  51. # built documents.
  52. #
  53. # The short X.Y version.
  54. from os_doc_tools.version import version_info as doc_tools_version
  55. # The full version, including alpha/beta/rc tags.
  56. release = doc_tools_version.version_string_with_vcs()
  57. # The short X.Y version.
  58. version = doc_tools_version.canonical_version_string()
  59. # The language for content autogenerated by Sphinx. Refer to documentation
  60. # for a list of supported languages.
  61. # language = None
  62. # There are two options for replacing |today|: either, you set today to some
  63. # non-false value, then it is used:
  64. # today = ''
  65. # Else, today_fmt is used as the format for a strftime call.
  66. # today_fmt = '%B %d, %Y'
  67. # List of patterns, relative to source directory, that match files and
  68. # directories to ignore when looking for source files.
  69. exclude_patterns = []
  70. # The reST default role (used for this markup: `text`) to use for all
  71. # documents.
  72. # default_role = None
  73. # If true, '()' will be appended to :func: etc. cross-reference text.
  74. # add_function_parentheses = True
  75. # If true, the current module name will be prepended to all description
  76. # unit titles (such as .. function::).
  77. # add_module_names = True
  78. # If true, sectionauthor and moduleauthor directives will be shown in the
  79. # output. They are ignored by default.
  80. # show_authors = False
  81. # The name of the Pygments (syntax highlighting) style to use.
  82. pygments_style = 'sphinx'
  83. # A list of ignored prefixes for module index sorting.
  84. # modindex_common_prefix = []
  85. # If true, keep warnings as "system message" paragraphs in the built documents.
  86. # keep_warnings = False
  87. # -- Options for HTML output ----------------------------------------------
  88. # The theme to use for HTML and HTML Help pages. See the documentation for
  89. # a list of builtin themes.
  90. html_theme = 'openstackdocs'
  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. # Add any extra paths that contain custom files (such as robots.txt or
  114. # .htaccess) here, relative to this directory. These files are copied
  115. # directly to the root of the documentation.
  116. # html_extra_path = []
  117. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  118. # using the given strftime format.
  119. # html_last_updated_fmt = '%b %d, %Y'
  120. html_last_updated_fmt = '%Y-%m-%d %H:%M'
  121. # If true, SmartyPants will be used to convert quotes and dashes to
  122. # typographically correct entities.
  123. # html_use_smartypants = True
  124. # Custom sidebar templates, maps document names to template names.
  125. # html_sidebars = {}
  126. # Additional templates that should be rendered to pages, maps page names to
  127. # template names.
  128. # html_additional_pages = {}
  129. # If false, no module index is generated.
  130. # html_domain_indices = True
  131. # If false, no index is generated.
  132. # html_use_index = True
  133. # If true, the index is split into individual pages for each letter.
  134. # html_split_index = False
  135. # If true, links to the reST sources are added to the pages.
  136. # html_show_sourcelink = True
  137. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  138. # html_show_sphinx = True
  139. # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  140. # html_show_copyright = True
  141. # If true, an OpenSearch description file will be output, and all pages will
  142. # contain a <link> tag referring to it. The value of this option must be the
  143. # base URL from which the finished HTML is served.
  144. # html_use_opensearch = ''
  145. # This is the file name suffix for HTML files (e.g. ".xhtml").
  146. # html_file_suffix = None
  147. # Output file base name for HTML help builder.
  148. htmlhelp_basename = 'OpenStack-Doc-Tools-ReleaseNotesdoc'
  149. # -- Options for LaTeX output ---------------------------------------------
  150. latex_elements = {
  151. # The paper size ('letterpaper' or 'a4paper').
  152. # 'papersize': 'letterpaper',
  153. # The font size ('10pt', '11pt' or '12pt').
  154. # 'pointsize': '10pt',
  155. # Additional stuff for the LaTeX preamble.
  156. # 'preamble': '',
  157. }
  158. # Grouping the document tree into LaTeX files. List of tuples
  159. # (source start file, target name, title,
  160. # author, documentclass [howto, manual, or own class]).
  161. latex_documents = [
  162. ('index', 'OpenStack-Doc-Tools-ReleaseNotes.tex',
  163. u'OpenStack-Doc-Tools Release Notes Documentation',
  164. u'Documentation Team', 'manual'),
  165. ]
  166. # The name of an image file (relative to this directory) to place at the top of
  167. # the title page.
  168. # latex_logo = None
  169. # For "manual" documents, if this is true, then toplevel headings are parts,
  170. # not chapters.
  171. # latex_use_parts = False
  172. # If true, show page references after internal links.
  173. # latex_show_pagerefs = False
  174. # If true, show URL addresses after external links.
  175. # latex_show_urls = False
  176. # Documents to append as an appendix to all manuals.
  177. # latex_appendices = []
  178. # If false, no module index is generated.
  179. # latex_domain_indices = True
  180. # -- Options for manual page output ---------------------------------------
  181. # One entry per manual page. List of tuples
  182. # (source start file, name, description, authors, manual section).
  183. man_pages = [
  184. ('index', 'openstack-doc-tools-releasenotes',
  185. u'OpenStack-Doc-Tools Release Notes Documentation',
  186. [u'Documentation team'], 1)
  187. ]
  188. # If true, show URL addresses after external links.
  189. # man_show_urls = False
  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', 'OpenStack-Doc-Tools-ReleaseNotes',
  196. u'OpenStack-Doc-Tools Release Notes Documentation',
  197. u'Documentation Team', 'OpenStack-Doc-Tools-ReleaseNotes',
  198. 'One line description of project.',
  199. 'Miscellaneous'),
  200. ]
  201. # Documents to append as an appendix to all manuals.
  202. # texinfo_appendices = []
  203. # If false, no module index is generated.
  204. # texinfo_domain_indices = True
  205. # How to display URL addresses: 'footnote', 'no', or 'inline'.
  206. # texinfo_show_urls = 'footnote'
  207. # If true, do not generate a @detailmenu in the "Top" node's menu.
  208. # texinfo_no_detailmenu = False
  209. # -- Options for Internationalization output ------------------------------
  210. locale_dirs = ['locale/']