OpenStack Compute (Nova)
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.6KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238
  1. # Nova Release Notes documentation build configuration file, created by
  2. # sphinx-quickstart on Thu Nov 5 11:50:32 2015.
  3. #
  4. # This file is execfile()d with the current directory set to its
  5. # containing dir.
  6. #
  7. # Note that not all possible configuration values are present in this
  8. # autogenerated file.
  9. #
  10. # All configuration values have a default; values that are commented out
  11. # serve to show the default.
  12. # If extensions (or modules to document with autodoc) are in another directory,
  13. # add these directories to sys.path here. If the directory is relative to the
  14. # documentation root, use os.path.abspath to make it absolute, like shown here.
  15. #sys.path.insert(0, os.path.abspath('.'))
  16. # -- General configuration ------------------------------------------------
  17. # If your documentation needs a minimal Sphinx version, state it here.
  18. #needs_sphinx = '1.0'
  19. # Add any Sphinx extension module names here, as strings. They can be
  20. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  21. # ones.
  22. extensions = [
  23. 'openstackdocstheme',
  24. 'reno.sphinxext',
  25. ]
  26. # Add any paths that contain templates here, relative to this directory.
  27. templates_path = ['_templates']
  28. # The suffix of source filenames.
  29. source_suffix = '.rst'
  30. # The encoding of source files.
  31. #source_encoding = 'utf-8-sig'
  32. # The master toctree document.
  33. master_doc = 'index'
  34. # General information about the project.
  35. copyright = u'2015, Nova developers'
  36. # openstackdocstheme options
  37. repository_name = 'openstack/nova'
  38. bug_project = 'nova'
  39. bug_tag = ''
  40. # The language for content autogenerated by Sphinx. Refer to documentation
  41. # for a list of supported languages.
  42. #language = None
  43. # There are two options for replacing |today|: either, you set today to some
  44. # non-false value, then it is used:
  45. #today = ''
  46. # Else, today_fmt is used as the format for a strftime call.
  47. #today_fmt = '%B %d, %Y'
  48. # List of patterns, relative to source directory, that match files and
  49. # directories to ignore when looking for source files.
  50. exclude_patterns = []
  51. # The reST default role (used for this markup: `text`) to use for all
  52. # documents.
  53. #default_role = None
  54. # If true, '()' will be appended to :func: etc. cross-reference text.
  55. #add_function_parentheses = True
  56. # If true, the current module name will be prepended to all description
  57. # unit titles (such as .. function::).
  58. #add_module_names = True
  59. # If true, sectionauthor and moduleauthor directives will be shown in the
  60. # output. They are ignored by default.
  61. #show_authors = False
  62. # The name of the Pygments (syntax highlighting) style to use.
  63. pygments_style = 'sphinx'
  64. # A list of ignored prefixes for module index sorting.
  65. #modindex_common_prefix = []
  66. # If true, keep warnings as "system message" paragraphs in the built documents.
  67. #keep_warnings = False
  68. # -- Options for HTML output ----------------------------------------------
  69. # The theme to use for HTML and HTML Help pages. See the documentation for
  70. # a list of builtin themes.
  71. html_theme = 'openstackdocs'
  72. # Theme options are theme-specific and customize the look and feel of a theme
  73. # further. For a list of options available for each theme, see the
  74. # documentation.
  75. #html_theme_options = {}
  76. # Add any paths that contain custom themes here, relative to this directory.
  77. # html_theme_path = []
  78. # The name for this set of Sphinx documents. If None, it defaults to
  79. # "<project> v<release> documentation".
  80. #html_title = None
  81. # A shorter title for the navigation bar. Default is the same as html_title.
  82. #html_short_title = None
  83. # The name of an image file (relative to this directory) to place at the top
  84. # of the sidebar.
  85. #html_logo = None
  86. # The name of an image file (within the static path) to use as favicon of the
  87. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  88. # pixels large.
  89. #html_favicon = None
  90. # Add any paths that contain custom static files (such as style sheets) here,
  91. # relative to this directory. They are copied after the builtin static files,
  92. # so a file named "default.css" will overwrite the builtin "default.css".
  93. html_static_path = ['_static']
  94. # Add any extra paths that contain custom files (such as robots.txt or
  95. # .htaccess) here, relative to this directory. These files are copied
  96. # directly to the root of the documentation.
  97. #html_extra_path = []
  98. # If true, SmartyPants will be used to convert quotes and dashes to
  99. # typographically correct entities.
  100. #html_use_smartypants = True
  101. # Custom sidebar templates, maps document names to template names.
  102. #html_sidebars = {}
  103. # Additional templates that should be rendered to pages, maps page names to
  104. # template names.
  105. #html_additional_pages = {}
  106. # If false, no module index is generated.
  107. #html_domain_indices = True
  108. # If false, no index is generated.
  109. html_use_index = False
  110. # If true, the index is split into individual pages for each letter.
  111. #html_split_index = False
  112. # If true, links to the reST sources are added to the pages.
  113. #html_show_sourcelink = True
  114. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  115. #html_show_sphinx = True
  116. # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  117. #html_show_copyright = True
  118. # If true, an OpenSearch description file will be output, and all pages will
  119. # contain a <link> tag referring to it. The value of this option must be the
  120. # base URL from which the finished HTML is served.
  121. #html_use_opensearch = ''
  122. # This is the file name suffix for HTML files (e.g. ".xhtml").
  123. #html_file_suffix = None
  124. # Output file base name for HTML help builder.
  125. htmlhelp_basename = 'NovaReleaseNotesdoc'
  126. # -- Options for LaTeX output ---------------------------------------------
  127. # Grouping the document tree into LaTeX files. List of tuples
  128. # (source start file, target name, title,
  129. # author, documentclass [howto, manual, or own class]).
  130. latex_documents = [
  131. ('index', 'NovaReleaseNotes.tex', u'Nova Release Notes Documentation',
  132. u'Nova developers', 'manual'),
  133. ]
  134. # The name of an image file (relative to this directory) to place at the top of
  135. # the title page.
  136. #latex_logo = None
  137. # For "manual" documents, if this is true, then toplevel headings are parts,
  138. # not chapters.
  139. #latex_use_parts = False
  140. # If true, show page references after internal links.
  141. #latex_show_pagerefs = False
  142. # If true, show URL addresses after external links.
  143. #latex_show_urls = False
  144. # Documents to append as an appendix to all manuals.
  145. #latex_appendices = []
  146. # If false, no module index is generated.
  147. #latex_domain_indices = True
  148. # -- Options for manual page output ---------------------------------------
  149. # One entry per manual page. List of tuples
  150. # (source start file, name, description, authors, manual section).
  151. man_pages = [
  152. ('index', 'novareleasenotes', u'Nova Release Notes Documentation',
  153. [u'Nova developers'], 1)
  154. ]
  155. # If true, show URL addresses after external links.
  156. #man_show_urls = False
  157. # -- Options for Texinfo output -------------------------------------------
  158. # Grouping the document tree into Texinfo files. List of tuples
  159. # (source start file, target name, title, author,
  160. # dir menu entry, description, category)
  161. texinfo_documents = [
  162. ('index', 'NovaReleaseNotes', u'Nova Release Notes Documentation',
  163. u'Nova developers', 'NovaReleaseNotes', 'One line description of project.',
  164. 'Miscellaneous'),
  165. ]
  166. # Documents to append as an appendix to all manuals.
  167. #texinfo_appendices = []
  168. # If false, no module index is generated.
  169. #texinfo_domain_indices = True
  170. # How to display URL addresses: 'footnote', 'no', or 'inline'.
  171. #texinfo_show_urls = 'footnote'
  172. # If true, do not generate a @detailmenu in the "Top" node's menu.
  173. #texinfo_no_detailmenu = False
  174. # -- Options for Internationalization output ------------------------------
  175. locale_dirs = ['locale/']