Split maven-stage script into a reusable macro
[releng/global-jjb.git] / docs / conf.py
1 #!/usr/bin/env python3
2 # -*- coding: utf-8 -*-
3 #
4 # Linux Foundation Release Engineering Tools documentation build configuration file, created by
5 # sphinx-quickstart on Sat Mar  4 12:20:05 2017.
6 #
7 # This file is execfile()d with the current directory set to its
8 # containing dir.
9 #
10 # Note that not all possible configuration values are present in this
11 # autogenerated file.
12 #
13 # All configuration values have a default; values that are commented out
14 # serve to show the default.
15
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 #
20 import os
21 import sys
22 import sphinx_bootstrap_theme
23 sys.path.insert(0, os.path.abspath('..'))
24
25 # -- General configuration ------------------------------------------------
26
27 # If your documentation needs a minimal Sphinx version, state it here.
28 #
29 # needs_sphinx = '1.0'
30
31 # Add any Sphinx extension module names here, as strings. They can be
32 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
33 # ones.
34 extensions = [
35     'sphinx.ext.autodoc',
36     'sphinx.ext.doctest',
37     'sphinx.ext.intersphinx',
38     'sphinx.ext.todo',
39     'sphinx.ext.coverage',
40     'sphinx.ext.viewcode',
41     'sphinxcontrib.programoutput',
42 ]
43
44 # Add any paths that contain templates here, relative to this directory.
45 templates_path = ['_templates']
46
47 # The suffix(es) of source filenames.
48 # You can specify multiple suffix as a list of string:
49 #
50 # source_suffix = ['.rst', '.md']
51 source_suffix = '.rst'
52
53 # The encoding of source files.
54 #
55 # source_encoding = 'utf-8-sig'
56
57 # The master toctree document.
58 master_doc = 'index'
59
60 # General information about the project.
61 project = 'lf-releng-global-jjb'
62 copyright = '2017, The Linux Foundation'
63 author = 'Linux Foundation Releng'
64
65 # The version info for the project you're documenting, acts as replacement for
66 # |version| and |release|, also used in various other places throughout the
67 # built documents.
68 #
69 # The short X.Y version.
70 version = '0.16.0-dev'
71 # The full version, including alpha/beta/rc tags.
72 release = version
73
74 # The language for content autogenerated by Sphinx. Refer to documentation
75 # for a list of supported languages.
76 #
77 # This is also used if you do content translation via gettext catalogs.
78 # Usually you set "language" from the command line for these cases.
79 language = None
80
81 # There are two options for replacing |today|: either, you set today to some
82 # non-false value, then it is used:
83 #
84 # today = ''
85 #
86 # Else, today_fmt is used as the format for a strftime call.
87 #
88 # today_fmt = '%B %d, %Y'
89
90 # List of patterns, relative to source directory, that match files and
91 # directories to ignore when looking for source files.
92 # This patterns also effect to html_static_path and html_extra_path
93 exclude_patterns = []
94
95 # The reST default role (used for this markup: `text`) to use for all
96 # documents.
97 #
98 # default_role = None
99
100 # If true, '()' will be appended to :func: etc. cross-reference text.
101 #
102 # add_function_parentheses = True
103
104 # If true, the current module name will be prepended to all description
105 # unit titles (such as .. function::).
106 #
107 # add_module_names = True
108
109 # If true, sectionauthor and moduleauthor directives will be shown in the
110 # output. They are ignored by default.
111 #
112 # show_authors = False
113
114 # The name of the Pygments (syntax highlighting) style to use.
115 pygments_style = 'sphinx'
116
117 # A list of ignored prefixes for module index sorting.
118 # modindex_common_prefix = []
119
120 # If true, keep warnings as "system message" paragraphs in the built documents.
121 # keep_warnings = False
122
123 # If true, `todo` and `todoList` produce output, else they produce nothing.
124 todo_include_todos = True
125
126
127 # -- Options for HTML output ----------------------------------------------
128
129 # The theme to use for HTML and HTML Help pages.  See the documentation for
130 # a list of builtin themes.
131 #
132 html_theme = 'bootstrap'
133
134 # Theme options are theme-specific and customize the look and feel of a theme
135 # further.  For a list of options available for each theme, see the
136 # documentation.
137 #
138 # html_theme_options = {}
139 html_theme_options = {
140     'bootswatch_theme': "cerulean",
141     'navbar_sidebarrel': False,
142     'source_link_position': "footer",
143 }
144
145 # Add any paths that contain custom themes here, relative to this directory.
146 # html_theme_path = []
147 html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
148
149 # The name for this set of Sphinx documents.
150 # "<project> v<release> documentation" by default.
151 #
152 # html_title = 'Linux Foundation Release Engineering Tools v0.0.1'
153
154 # A shorter title for the navigation bar.  Default is the same as html_title.
155 #
156 # html_short_title = None
157
158 # The name of an image file (relative to this directory) to place at the top
159 # of the sidebar.
160 #
161 html_logo = '_static/lf-logo-small.png'
162
163 # The name of an image file (relative to this directory) to use as a favicon of
164 # the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
165 # pixels large.
166 #
167 html_favicon = 'favicon.ico'
168
169 # Add any paths that contain custom static files (such as style sheets) here,
170 # relative to this directory. They are copied after the builtin static files,
171 # so a file named "default.css" will overwrite the builtin "default.css".
172 html_static_path = ['_static']
173
174 # Add any extra paths that contain custom files (such as robots.txt or
175 # .htaccess) here, relative to this directory. These files are copied
176 # directly to the root of the documentation.
177 #
178 # html_extra_path = []
179
180 # If not None, a 'Last updated on:' timestamp is inserted at every page
181 # bottom, using the given strftime format.
182 # The empty string is equivalent to '%b %d, %Y'.
183 #
184 # html_last_updated_fmt = None
185
186 # If true, SmartyPants will be used to convert quotes and dashes to
187 # typographically correct entities.
188 #
189 # html_use_smartypants = True
190
191 # Custom sidebar templates, maps document names to template names.
192 #
193 html_sidebars = {
194     '**': ['localtoc.html', 'relations.html'],
195 }
196
197 # Additional templates that should be rendered to pages, maps page names to
198 # template names.
199 #
200 # html_additional_pages = {}
201
202 # If false, no module index is generated.
203 #
204 # html_domain_indices = True
205
206 # If false, no index is generated.
207 #
208 # html_use_index = True
209
210 # If true, the index is split into individual pages for each letter.
211 #
212 # html_split_index = False
213
214 # If true, links to the reST sources are added to the pages.
215 #
216 # html_show_sourcelink = True
217
218 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
219 #
220 # html_show_sphinx = True
221
222 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
223 #
224 # html_show_copyright = True
225
226 # If true, an OpenSearch description file will be output, and all pages will
227 # contain a <link> tag referring to it.  The value of this option must be the
228 # base URL from which the finished HTML is served.
229 #
230 # html_use_opensearch = ''
231
232 # This is the file name suffix for HTML files (e.g. ".xhtml").
233 # html_file_suffix = None
234
235 # Language to be used for generating the HTML full-text search index.
236 # Sphinx supports the following languages:
237 #   'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
238 #   'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
239 #
240 # html_search_language = 'en'
241
242 # A dictionary with options for the search language support, empty by default.
243 # 'ja' uses this config value.
244 # 'zh' user can custom change `jieba` dictionary path.
245 #
246 # html_search_options = {'type': 'default'}
247
248 # The name of a javascript file (relative to the configuration directory) that
249 # implements a search results scorer. If empty, the default will be used.
250 #
251 # html_search_scorer = 'scorer.js'
252
253 # Output file base name for HTML help builder.
254 htmlhelp_basename = 'LinuxFoundationReleaseEngineeringGJJBdoc'
255
256 # Example configuration for intersphinx: refer to the Python standard library.
257 intersphinx_mapping = {
258     'jjb': ('https://docs.openstack.org/infra/jenkins-job-builder/', None),
259     'lftools': ('http://lftools.releng.linuxfoundation.org/en/latest/', None),
260     'python': ('https://docs.python.org/', None),
261 }