Tools to make Jenkins jobs from templates
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

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258
  1. # -*- coding: utf-8 -*-
  2. #
  3. # Jenkins Job Builder documentation build configuration file, created by
  4. # sphinx-quickstart on Mon Sep 10 19:36:21 2012.
  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 os
  14. import sys
  15. from jenkins_jobs.version import version_info as jenkins_jobs_version
  16. # If extensions (or modules to document with autodoc) are in another directory,
  17. # add these directories to sys.path here. If the directory is relative to the
  18. # documentation root, use os.path.abspath to make it absolute, like shown here.
  19. sys.path.insert(0, os.path.abspath('../..'))
  20. sys.path.insert(0, os.path.abspath('../../jenkins_jobs/modules'))
  21. # -- General configuration ----------------------------------------------------
  22. # If your documentation needs a minimal Sphinx version, state it here.
  23. # needs_sphinx = '1.0'
  24. # Add any Sphinx extension module names here, as strings. They can be
  25. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  26. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage',
  27. 'jenkins_jobs.sphinx.yaml', 'sphinxcontrib.programoutput',
  28. 'sphinx.ext.extlinks']
  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. project = u'Jenkins Job Builder'
  39. copyright = u'2012, Jenkins Job Builder Maintainers'
  40. # The version info for the project you're documenting, acts as replacement for
  41. # |version| and |release|, also used in various other places throughout the
  42. # built documents.
  43. #
  44. # Version info
  45. release = jenkins_jobs_version.version_string_with_vcs()
  46. # The short X.Y version.
  47. version = jenkins_jobs_version.canonical_version_string()
  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. # The reST default role (used for this markup: `text`) to use for all 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 = 'sphinx'
  71. # A list of ignored prefixes for module index sorting.
  72. # modindex_common_prefix = []
  73. # -- Options for HTML output --------------------------------------------------
  74. # The theme to use for HTML and HTML Help pages. See the documentation for
  75. # a list of builtin themes.
  76. html_theme = 'default'
  77. # Theme options are theme-specific and customize the look and feel of a theme
  78. # further. For a list of options available for each theme, see the
  79. # documentation.
  80. # html_theme_options = {}
  81. # Add any paths that contain custom themes here, relative to this directory.
  82. # html_theme_path = []
  83. # The name for this set of Sphinx documents. If None, it defaults to
  84. # "<project> v<release> documentation".
  85. # html_title = None
  86. # A shorter title for the navigation bar. Default is the same as html_title.
  87. # html_short_title = None
  88. # The name of an image file (relative to this directory) to place at the top
  89. # of the sidebar.
  90. # html_logo = None
  91. # The name of an image file (within the static path) to use as favicon of the
  92. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  93. # pixels large.
  94. # html_favicon = None
  95. # Add any paths that contain custom static files (such as style sheets) here,
  96. # relative to this directory. They are copied after the builtin static files,
  97. # so a file named "default.css" will overwrite the builtin "default.css".
  98. # html_static_path = ['_static']
  99. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  100. # using the given strftime format.
  101. # html_last_updated_fmt = '%b %d, %Y'
  102. # If true, SmartyPants will be used to convert quotes and dashes to
  103. # typographically correct entities.
  104. # html_use_smartypants = True
  105. # Custom sidebar templates, maps document names to template names.
  106. # html_sidebars = {}
  107. # Additional templates that should be rendered to pages, maps page names to
  108. # template names.
  109. # html_additional_pages = {}
  110. # If false, no module index is generated.
  111. # html_domain_indices = True
  112. # If false, no index is generated.
  113. # html_use_index = True
  114. # If true, the index is split into individual pages for each letter.
  115. # html_split_index = False
  116. # If true, links to the reST sources are added to the pages.
  117. # html_show_sourcelink = True
  118. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  119. # html_show_sphinx = True
  120. # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  121. # html_show_copyright = True
  122. # If true, an OpenSearch description file will be output, and all pages will
  123. # contain a <link> tag referring to it. The value of this option must be the
  124. # base URL from which the finished HTML is served.
  125. # html_use_opensearch = ''
  126. # This is the file name suffix for HTML files (e.g. ".xhtml").
  127. # html_file_suffix = None
  128. # Output file base name for HTML help builder.
  129. htmlhelp_basename = 'JenkinsJobBuilderdoc'
  130. # -- Options for LaTeX output -------------------------------------------------
  131. latex_elements = {
  132. # The paper size ('letterpaper' or 'a4paper').
  133. # 'papersize': 'letterpaper',
  134. # The font size ('10pt', '11pt' or '12pt').
  135. # 'pointsize': '10pt',
  136. # Additional stuff for the LaTeX preamble.
  137. # 'preamble': '',
  138. }
  139. # Grouping the document tree into LaTeX files. List of tuples
  140. # (source start file, target name, title, author, documentclass
  141. # [howto/manual]).
  142. latex_documents = [
  143. ('index', 'JenkinsJobBuilder.tex', u'Jenkins Job Builder Documentation',
  144. u'Jenkins Job Builder Maintainers', '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 linkcheck ----------------------------------------------------
  161. # If set, override pythons default socket timeout
  162. # testing has shown the default is too short so explicitly increase to 15 secs
  163. linkcheck_timeout = 15
  164. # -- Options for manual page output ------------------------------------------
  165. # One entry per manual page. List of tuples
  166. # (source start file, name, description, authors, manual section).
  167. man_pages = [
  168. ('index', 'jenkins-jobs', u'Jenkins Job Builder Documentation',
  169. [u'Jenkins Job Builder Maintainers'], 1)
  170. ]
  171. # If true, show URL addresses after external links.
  172. # man_show_urls = False
  173. # -- Options for Texinfo output -----------------------------------------------
  174. # Grouping the document tree into Texinfo files. List of tuples
  175. # (source start file, target name, title, author,
  176. # dir menu entry, description, category)
  177. texinfo_documents = [
  178. ('index', 'JenkinsJobBuilder', u'Jenkins Job Builder Documentation',
  179. u'Jenkins Job Builder Maintainers',
  180. 'JenkinsJobBuilder', 'One line description of project.',
  181. 'Miscellaneous'),
  182. ]
  183. # Documents to append as an appendix to all manuals.
  184. # texinfo_appendices = []
  185. # If false, no module index is generated.
  186. # texinfo_domain_indices = True
  187. # How to display URL addresses: 'footnote', 'no', or 'inline'.
  188. # texinfo_show_urls = 'footnote'
  189. extlinks = {'jenkins-wiki': ('https://wiki.jenkins.io/display/JENKINS/%s',
  190. None)}