Puppet provider for virtual switches.
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.
 
 
 
 

257 lines
8.4 KiB

  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. #
  15. # If extensions (or modules to document with autodoc) are in another directory,
  16. # add these directories to sys.path here. If the directory is relative to the
  17. # documentation root, use os.path.abspath to make it absolute, like shown here.
  18. #sys.path.insert(0, os.path.abspath('.'))
  19. # -- General configuration ------------------------------------------------
  20. # If your documentation needs a minimal Sphinx version, state it here.
  21. #needs_sphinx = '1.0'
  22. # Add any Sphinx extension module names here, as strings. They can be
  23. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  24. # ones.
  25. extensions = [
  26. 'openstackdocstheme',
  27. 'reno.sphinxext',
  28. ]
  29. # Add any paths that contain templates here, relative to this directory.
  30. templates_path = ['_templates']
  31. # The suffix of source filenames.
  32. source_suffix = '.rst'
  33. # The encoding of source files.
  34. #source_encoding = 'utf-8-sig'
  35. # The master toctree document.
  36. master_doc = 'index'
  37. # General information about the project.
  38. copyright = u'2017, Puppet OpenStack Developers'
  39. # The version info for the project you're documenting, acts as replacement for
  40. # |version| and |release|, also used in various other places throughout the
  41. # built documents.
  42. #
  43. # The short X.Y version.
  44. version = ''
  45. # The full version, including alpha/beta/rc tags.
  46. release = ''
  47. # The language for content autogenerated by Sphinx. Refer to documentation
  48. # for a list of supported languages.
  49. #language = None
  50. # There are two options for replacing |today|: either, you set today to some
  51. # non-false value, then it is used:
  52. #today = ''
  53. # Else, today_fmt is used as the format for a strftime call.
  54. #today_fmt = '%B %d, %Y'
  55. # List of patterns, relative to source directory, that match files and
  56. # directories to ignore when looking for source files.
  57. exclude_patterns = []
  58. # The reST default role (used for this markup: `text`) to use for all
  59. # documents.
  60. #default_role = None
  61. # If true, '()' will be appended to :func: etc. cross-reference text.
  62. #add_function_parentheses = True
  63. # If true, the current module name will be prepended to all description
  64. # unit titles (such as .. function::).
  65. #add_module_names = True
  66. # If true, sectionauthor and moduleauthor directives will be shown in the
  67. # output. They are ignored by default.
  68. #show_authors = False
  69. # The name of the Pygments (syntax highlighting) style to use.
  70. pygments_style = 'native'
  71. # A list of ignored prefixes for module index sorting.
  72. #modindex_common_prefix = []
  73. # If true, keep warnings as "system message" paragraphs in the built documents.
  74. #keep_warnings = False
  75. # -- Options for HTML output ----------------------------------------------
  76. # The theme to use for HTML and HTML Help pages. See the documentation for
  77. # a list of builtin themes.
  78. html_theme = 'openstackdocs'
  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. # Add any paths that contain custom static files (such as style sheets) here,
  98. # relative to this directory. They are copied after the builtin static files,
  99. # so a file named "default.css" will overwrite the builtin "default.css".
  100. html_static_path = ['_static']
  101. # Add any extra paths that contain custom files (such as robots.txt or
  102. # .htaccess) here, relative to this directory. These files are copied
  103. # directly to the root of the documentation.
  104. #html_extra_path = []
  105. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  106. # using the given strftime format.
  107. # If true, SmartyPants will be used to convert quotes and dashes to
  108. # typographically correct entities.
  109. #html_use_smartypants = True
  110. # Custom sidebar templates, maps document names to template names.
  111. #html_sidebars = {}
  112. # Additional templates that should be rendered to pages, maps page names to
  113. # template names.
  114. #html_additional_pages = {}
  115. # If false, no module index is generated.
  116. #html_domain_indices = True
  117. # If false, no index is generated.
  118. #html_use_index = True
  119. # If true, the index is split into individual pages for each letter.
  120. #html_split_index = False
  121. # If true, links to the reST sources are added to the pages.
  122. #html_show_sourcelink = True
  123. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  124. #html_show_sphinx = True
  125. # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  126. #html_show_copyright = True
  127. # If true, an OpenSearch description file will be output, and all pages will
  128. # contain a <link> tag referring to it. The value of this option must be the
  129. # base URL from which the finished HTML is served.
  130. #html_use_opensearch = ''
  131. # This is the file name suffix for HTML files (e.g. ".xhtml").
  132. #html_file_suffix = None
  133. # Output file base name for HTML help builder.
  134. htmlhelp_basename = 'puppet-vswitchReleaseNotesdoc'
  135. # -- Options for LaTeX output ---------------------------------------------
  136. # Grouping the document tree into LaTeX files. List of tuples
  137. # (source start file, target name, title,
  138. # author, documentclass [howto, manual, or own class]).
  139. latex_documents = [
  140. ('index', 'puppet-vswitchReleaseNotes.tex', u'puppet-vswitch Release Notes Documentation',
  141. u'2017, Puppet OpenStack Developers', 'manual'),
  142. ]
  143. # The name of an image file (relative to this directory) to place at the top of
  144. # the title page.
  145. #latex_logo = None
  146. # For "manual" documents, if this is true, then toplevel headings are parts,
  147. # not chapters.
  148. #latex_use_parts = False
  149. # If true, show page references after internal links.
  150. #latex_show_pagerefs = False
  151. # If true, show URL addresses after external links.
  152. #latex_show_urls = False
  153. # Documents to append as an appendix to all manuals.
  154. #latex_appendices = []
  155. # If false, no module index is generated.
  156. #latex_domain_indices = True
  157. # -- Options for manual page output ---------------------------------------
  158. # One entry per manual page. List of tuples
  159. # (source start file, name, description, authors, manual section).
  160. man_pages = [
  161. ('index', 'puppet-vswitchreleasenotes', u'puppet-vswitch Release Notes Documentation',
  162. [u'2017, Puppet OpenStack Developers'], 1)
  163. ]
  164. # If true, show URL addresses after external links.
  165. #man_show_urls = False
  166. # -- Options for Texinfo output -------------------------------------------
  167. # Grouping the document tree into Texinfo files. List of tuples
  168. # (source start file, target name, title, author,
  169. # dir menu entry, description, category)
  170. texinfo_documents = [
  171. ('index', 'puppet-vswitchReleaseNotes', u'puppet-vswitch Release Notes Documentation',
  172. u'2017, Puppet OpenStack Developers', 'puppet-vswitchReleaseNotes', 'One line description of project.',
  173. 'Miscellaneous'),
  174. ]
  175. # Documents to append as an appendix to all manuals.
  176. #texinfo_appendices = []
  177. # If false, no module index is generated.
  178. #texinfo_domain_indices = True
  179. # How to display URL addresses: 'footnote', 'no', or 'inline'.
  180. #texinfo_show_urls = 'footnote'
  181. # If true, do not generate a @detailmenu in the "Top" node's menu.
  182. #texinfo_no_detailmenu = False
  183. # -- Options for Internationalization output ------------------------------
  184. locale_dirs = ['locale/']
  185. # openstackdocstheme options
  186. openstackdocs_repo_name = 'openstack/puppet-vswitch'
  187. openstackdocs_bug_project = 'puppet-vswitch'
  188. openstackdocs_bug_tag = ''
  189. openstackdocs_auto_name = False