Integrated deployment configuration and 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.

conf.py 4.8KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160
  1. # -*- coding: utf-8 -*-
  2. #
  3. # shipyard documentation build configuration file, created by
  4. # sphinx-quickstart on Sat Sep 16 03:40:50 2017.
  5. #
  6. # This file is execfile()d with the current directory set to its
  7. # containing 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. # If extensions (or modules to document with autodoc) are in another directory,
  15. # add these directories to sys.path here. If the directory is relative to the
  16. # documentation root, use os.path.abspath to make it absolute, like shown here.
  17. #
  18. # import os
  19. # import sys
  20. # sys.path.insert(0, os.path.abspath('.'))
  21. import sphinx_rtd_theme
  22. # -- General configuration ------------------------------------------------
  23. # If your documentation needs a minimal Sphinx version, state it here.
  24. #
  25. # needs_sphinx = '1.0'
  26. # Add any Sphinx extension module names here, as strings. They can be
  27. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  28. # ones.
  29. extensions = [
  30. 'sphinx.ext.autodoc',
  31. 'sphinx.ext.todo',
  32. 'sphinx.ext.viewcode',
  33. ]
  34. # Add any paths that contain templates here, relative to this directory.
  35. # templates_path = []
  36. # The suffix(es) of source filenames.
  37. # You can specify multiple suffix as a list of string:
  38. #
  39. # source_suffix = ['.rst', '.md']
  40. source_suffix = '.rst'
  41. # The master toctree document.
  42. master_doc = 'index'
  43. # General information about the project.
  44. project = u'UCP Integration'
  45. copyright = u'2017 AT&T Intellectual Property.'
  46. author = u'Undercloud Authors'
  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. #
  51. # The short X.Y version.
  52. version = u'0.1.0'
  53. # The full version, including alpha/beta/rc tags.
  54. release = u'0.1.0'
  55. # The language for content autogenerated by Sphinx. Refer to documentation
  56. # for a list of supported languages.
  57. #
  58. # This is also used if you do content translation via gettext catalogs.
  59. # Usually you set "language" from the command line for these cases.
  60. language = None
  61. # List of patterns, relative to source directory, that match files and
  62. # directories to ignore when looking for source files.
  63. # This patterns also effect to html_static_path and html_extra_path
  64. exclude_patterns = []
  65. # The name of the Pygments (syntax highlighting) style to use.
  66. pygments_style = 'sphinx'
  67. # If true, `todo` and `todoList` produce output, else they produce nothing.
  68. todo_include_todos = False
  69. # -- Options for HTML output ----------------------------------------------
  70. # The theme to use for HTML and HTML Help pages. See the documentation for
  71. # a list of builtin themes.
  72. #
  73. html_theme = "sphinx_rtd_theme"
  74. html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
  75. # Theme options are theme-specific and customize the look and feel of a theme
  76. # further. For a list of options available for each theme, see the
  77. # documentation.
  78. #
  79. # html_theme_options = {}
  80. # Add any paths that contain custom static files (such as style sheets) here,
  81. # relative to this directory. They are copied after the builtin static files,
  82. # so a file named "default.css" will overwrite the builtin "default.css".
  83. html_static_path = []
  84. # -- Options for HTMLHelp output ------------------------------------------
  85. # Output file base name for HTML help builder.
  86. htmlhelp_basename = 'ucpintdoc'
  87. # -- Options for LaTeX output ---------------------------------------------
  88. latex_elements = {
  89. # The paper size ('letterpaper' or 'a4paper').
  90. #
  91. # 'papersize': 'letterpaper',
  92. # The font size ('10pt', '11pt' or '12pt').
  93. #
  94. # 'pointsize': '10pt',
  95. # Additional stuff for the LaTeX preamble.
  96. #
  97. # 'preamble': '',
  98. # Latex figure (float) alignment
  99. #
  100. # 'figure_align': 'htbp',
  101. }
  102. # Grouping the document tree into LaTeX files. List of tuples
  103. # (source start file, target name, title,
  104. # author, documentclass [howto, manual, or own class]).
  105. latex_documents = [
  106. (master_doc, 'ucpint.tex', u'UCP Integration Documentation',
  107. u'Undercloud Authors', 'manual'),
  108. ]
  109. # -- Options for manual page output ---------------------------------------
  110. # One entry per manual page. List of tuples
  111. # (source start file, name, description, authors, manual section).
  112. man_pages = [
  113. (master_doc, 'UCPIntegration', u'UCP Integration Documentation',
  114. [author], 1)
  115. ]
  116. # -- Options for Texinfo output -------------------------------------------
  117. # Grouping the document tree into Texinfo files. List of tuples
  118. # (source start file, target name, title, author,
  119. # dir menu entry, description, category)
  120. texinfo_documents = [
  121. (master_doc, 'UCP Integration', u'UCP Integration Documentation',
  122. author, 'UCP Integration',
  123. 'Undercloud Platform Integration documentation',
  124. 'Miscellaneous'),
  125. ]