← Back to branch summary

~jocave/checkbox/hybrid-amd-gpu-mods

« back to all changes in this revision

Viewing changes to plainbox/docs/conf.py

  • Committer: Tarmac
  • Author(s): Brendan Donegan
  • Date: 2013-06-03 11:12:58 UTC
  • mfrom: (2154.2.1 bug1185759)
  • Revision ID: tarmac-20130603111258-1b3m5ydvkf1accts
"[r=zkrynicki][bug=1185759][author=brendan-donegan] automatic merge by tarmac"

Show diffs side-by-side

added added

removed removed

Lines of Context:
plainbox/docs/conf.py
1
1
#!/usr/bin/env python3
2
2
# -*- coding: utf-8 -*-
3
3
#
4
 
# Plainbox documentation build configuration file, created by
 
4
# PlainBox documentation build configuration file, created by
5
5
# sphinx-quickstart on Wed Feb 13 11:18:39 2013.
6
6
#
7
 
# This file is execfile()d with the current directory set to its containing
8
 
# dir.
 
7
# This file is execfile()d with the current directory set to its containing dir.
9
8
#
10
9
# Note that not all possible configuration values are present in this
11
10
# autogenerated file.
13
12
# All configuration values have a default; values that are commented out
14
13
# serve to show the default.
15
14
 
16
 
import sys
17
 
import os
18
 
 
19
 
 
20
 
BASE_DIR = os.path.dirname(os.path.dirname(__file__))
21
 
 
22
 
try:
23
 
    import plainbox
24
 
except ImportError as exc:
25
 
    raise SystemExit("plainbox has to be importable")
26
 
else:
27
 
    modules_to_mock = [
28
 
        'xlsxwriter',
29
 
        'xlsxwriter.workbook',
30
 
        'xlsxwriter.utility',
31
 
        'requests',
32
 
        'requests.exceptions'
33
 
    ]
34
 
    # Inject mock modules so that we can build the
35
 
    # documentation without having the real stuff available
36
 
    from plainbox.vendor import mock
37
 
    for mod_name in modules_to_mock:
38
 
        sys.modules[mod_name] = mock.Mock()
39
 
 
40
 
# If extensions (or modules to document with autodoc) are in another
41
 
# directory, add these directories to sys.path here. If the directory is
42
 
# relative to the documentation root, use os.path.abspath to make it absolute,
43
 
# like shown here.
44
 
# sys.path.insert(0, os.path.abspath('.'))
45
 
 
46
 
# -- General configuration ---------------------------------------------------
 
15
import sys, os
 
16
 
 
17
# If extensions (or modules to document with autodoc) are in another directory,
 
18
# add these directories to sys.path here. If the directory is relative to the
 
19
# documentation root, use os.path.abspath to make it absolute, like shown here.
 
20
#sys.path.insert(0, os.path.abspath('.'))
 
21
 
 
22
# -- General configuration -----------------------------------------------------
47
23
 
48
24
# If your documentation needs a minimal Sphinx version, state it here.
49
 
# needs_sphinx = '1.0'
50
 
 
51
 
# Add any Sphinx extension module names here, as strings. They can be
52
 
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
53
 
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo',
54
 
              'sphinx.ext.coverage', 'sphinx.ext.viewcode',
55
 
              'plainbox.vendor.sphinxarg.ext']
56
 
 
57
 
autodoc_default_flags = ['members', 'undoc-members', 'inherited-members',
58
 
                         'show-inheritance']
 
25
#needs_sphinx = '1.0'
 
26
 
 
27
# Add any Sphinx extension module names here, as strings. They can be extensions
 
28
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 
29
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']
59
30
 
60
31
# Add any paths that contain templates here, relative to this directory.
61
32
templates_path = ['_templates']
64
35
source_suffix = '.rst'
65
36
 
66
37
# The encoding of source files.
67
 
# source_encoding = 'utf-8-sig'
 
38
#source_encoding = 'utf-8-sig'
68
39
 
69
40
# The master toctree document.
70
41
master_doc = 'index'
71
42
 
72
43
# General information about the project.
73
 
project = 'Plainbox'
74
 
copyright = '2012-2014 Canonical Ltd'
 
44
project = 'PlainBox'
 
45
copyright = '2013, Zygmunt Krynicki'
75
46
 
76
47
# The version info for the project you're documenting, acts as replacement for
77
48
# |version| and |release|, also used in various other places throughout the
78
49
# built documents.
79
50
#
80
51
# The short X.Y version.
81
 
version = "{0[0]}.{0[1]}".format(plainbox.__version__)
 
52
version = '0.4'
82
53
# The full version, including alpha/beta/rc tags.
83
 
release = "{0[0]}.{0[1]}.{0[2]}.{0[3]}.{0[4]}".format(plainbox.__version__)
 
54
release = '0.4 (dev)'
84
55
 
85
56
# The language for content autogenerated by Sphinx. Refer to documentation
86
57
# for a list of supported languages.
87
 
# language = None
 
58
#language = None
88
59
 
89
60
# There are two options for replacing |today|: either, you set today to some
90
61
# non-false value, then it is used:
91
 
# today = ''
 
62
#today = ''
92
63
# Else, today_fmt is used as the format for a strftime call.
93
 
# today_fmt = '%B %d, %Y'
 
64
#today_fmt = '%B %d, %Y'
94
65
 
95
66
# List of patterns, relative to source directory, that match files and
96
67
# directories to ignore when looking for source files.
97
68
exclude_patterns = []
98
69
 
99
 
# The reST default role (used for this markup: `text`) to use for all
100
 
# documents.
101
 
# default_role = None
 
70
# The reST default role (used for this markup: `text`) to use for all documents.
 
71
#default_role = None
102
72
 
103
73
# If true, '()' will be appended to :func: etc. cross-reference text.
104
 
# add_function_parentheses = True
 
74
#add_function_parentheses = True
105
75
 
106
76
# If true, the current module name will be prepended to all description
107
77
# unit titles (such as .. function::).
108
 
# add_module_names = True
 
78
#add_module_names = True
109
79
 
110
80
# If true, sectionauthor and moduleauthor directives will be shown in the
111
81
# output. They are ignored by default.
112
 
# show_authors = False
 
82
#show_authors = False
113
83
 
114
84
# The name of the Pygments (syntax highlighting) style to use.
115
85
pygments_style = 'sphinx'
116
86
 
117
87
# A list of ignored prefixes for module index sorting.
118
 
# modindex_common_prefix = []
119
 
 
120
 
 
121
 
# -- Options for HTML output -------------------------------------------------
 
88
#modindex_common_prefix = []
 
89
 
 
90
 
 
91
# -- Options for HTML output ---------------------------------------------------
 
92
 
 
93
try:
 
94
    import sphinx_bootstrap_theme
 
95
except ImportError:
 
96
    html_theme = 'default'
 
97
    html_theme_options = {}
 
98
else:
 
99
    html_theme = 'bootstrap'
 
100
    html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
 
101
    html_theme_options = {
 
102
        'bootswatch_theme': 'united',
 
103
        'navbar_class': "navbar navbar-inverse",
 
104
    }
122
105
 
123
106
# The theme to use for HTML and HTML Help pages.  See the documentation for
124
107
# a list of builtin themes.
125
 
#
126
 
# Use our custom theme. For now it only adds Disqus.com support but we may
127
 
# customize it further later on. The theme is called 'plainbox' and has one
128
 
# option which controls if disqus is active or not.
129
 
html_theme = 'plainbox'
130
108
 
131
109
# Theme options are theme-specific and customize the look and feel of a theme
132
110
# further.  For a list of options available for each theme, see the
133
111
# documentation.
134
 
#
135
 
# Due to the way disqus works, it's only going to work on
136
 
# plainbox.readthedocs.org so only use it if building for readthedocs.
137
 
 
138
 
html_theme_options = {
139
 
    'show_disqus': 'true' if os.environ.get(
140
 
        "READTHEDOCS", None) == 'True' else ''
141
 
}
 
112
#html_theme_options = {}
142
113
 
143
114
# Add any paths that contain custom themes here, relative to this directory.
144
 
html_theme_path = ['_theme']
 
115
#html_theme_path = []
145
116
 
146
117
# The name for this set of Sphinx documents.  If None, it defaults to
147
118
# "<project> v<release> documentation".
148
 
# html_title = None
 
119
#html_title = None
149
120
 
150
121
# A shorter title for the navigation bar.  Default is the same as html_title.
151
 
# html_short_title = None
 
122
#html_short_title = None
152
123
 
153
124
# The name of an image file (relative to this directory) to place at the top
154
125
# of the sidebar.
155
 
# html_logo = None
 
126
#html_logo = None
156
127
 
157
128
# The name of an image file (within the static path) to use as favicon of the
158
129
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
159
130
# pixels large.
160
 
# html_favicon = None
 
131
#html_favicon = None
161
132
 
162
133
# Add any paths that contain custom static files (such as style sheets) here,
163
134
# relative to this directory. They are copied after the builtin static files,
166
137
 
167
138
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
168
139
# using the given strftime format.
169
 
# html_last_updated_fmt = '%b %d, %Y'
 
140
#html_last_updated_fmt = '%b %d, %Y'
170
141
 
171
142
# If true, SmartyPants will be used to convert quotes and dashes to
172
143
# typographically correct entities.
173
 
# html_use_smartypants = True
 
144
#html_use_smartypants = True
174
145
 
175
146
# Custom sidebar templates, maps document names to template names.
176
 
# html_sidebars = {}
 
147
#html_sidebars = {}
177
148
 
178
149
# Additional templates that should be rendered to pages, maps page names to
179
150
# template names.
180
 
# html_additional_pages = {}
 
151
#html_additional_pages = {}
181
152
 
182
153
# If false, no module index is generated.
183
 
# html_domain_indices = True
 
154
#html_domain_indices = True
184
155
 
185
156
# If false, no index is generated.
186
 
# html_use_index = True
 
157
#html_use_index = True
187
158
 
188
159
# If true, the index is split into individual pages for each letter.
189
 
# html_split_index = False
 
160
#html_split_index = False
190
161
 
191
162
# If true, links to the reST sources are added to the pages.
192
 
# html_show_sourcelink = True
 
163
#html_show_sourcelink = True
193
164
 
194
 
# If true, "Created using Sphinx" is shown in the HTML footer. Default is
195
 
# True.
196
 
# html_show_sphinx = True
 
165
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 
166
#html_show_sphinx = True
197
167
 
198
168
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
199
 
# html_show_copyright = True
 
169
#html_show_copyright = True
200
170
 
201
171
# If true, an OpenSearch description file will be output, and all pages will
202
172
# contain a <link> tag referring to it.  The value of this option must be the
203
173
# base URL from which the finished HTML is served.
204
 
# html_use_opensearch = ''
 
174
#html_use_opensearch = ''
205
175
 
206
176
# This is the file name suffix for HTML files (e.g. ".xhtml").
207
 
# html_file_suffix = None
 
177
#html_file_suffix = None
208
178
 
209
179
# Output file base name for HTML help builder.
210
 
htmlhelp_basename = 'Plainboxdoc'
211
 
 
212
 
 
213
 
# -- Options for LaTeX output ------------------------------------------------
 
180
htmlhelp_basename = 'PlainBoxdoc'
 
181
 
 
182
 
 
183
# -- Options for LaTeX output --------------------------------------------------
214
184
 
215
185
latex_elements = {
216
 
    # The paper size ('letterpaper' or 'a4paper').
217
 
    # 'papersize': 'letterpaper',
218
 
 
219
 
    # The font size ('10pt', '11pt' or '12pt').
220
 
    # 'pointsize': '10pt',
221
 
 
222
 
    # Additional stuff for the LaTeX preamble.
223
 
    # 'preamble': '',
 
186
# The paper size ('letterpaper' or 'a4paper').
 
187
#'papersize': 'letterpaper',
 
188
 
 
189
# The font size ('10pt', '11pt' or '12pt').
 
190
#'pointsize': '10pt',
 
191
 
 
192
# Additional stuff for the LaTeX preamble.
 
193
#'preamble': '',
224
194
}
225
195
 
226
196
# Grouping the document tree into LaTeX files. List of tuples
227
 
# (source start file, target name, title, author,
228
 
# documentclass [howto/manual]).
 
197
# (source start file, target name, title, author, documentclass [howto/manual]).
229
198
latex_documents = [
230
 
    ('index', 'Plainbox.tex', 'Plainbox Documentation',
231
 
     'Zygmunt Krynicki', 'manual'),
 
199
  ('index', 'PlainBox.tex', 'PlainBox Documentation',
 
200
   'Zygmunt Krynicki', 'manual'),
232
201
]
233
202
 
234
 
# The name of an image file (relative to this directory) to place at the top
235
 
# of the title page.
236
 
# latex_logo = None
 
203
# The name of an image file (relative to this directory) to place at the top of
 
204
# the title page.
 
205
#latex_logo = None
237
206
 
238
207
# For "manual" documents, if this is true, then toplevel headings are parts,
239
208
# not chapters.
240
 
# latex_use_parts = False
 
209
#latex_use_parts = False
241
210
 
242
211
# If true, show page references after internal links.
243
 
# latex_show_pagerefs = False
 
212
#latex_show_pagerefs = False
244
213
 
245
214
# If true, show URL addresses after external links.
246
 
# latex_show_urls = False
 
215
#latex_show_urls = False
247
216
 
248
217
# Documents to append as an appendix to all manuals.
249
 
# latex_appendices = []
 
218
#latex_appendices = []
250
219
 
251
220
# If false, no module index is generated.
252
 
# latex_domain_indices = True
253
 
 
254
 
 
255
 
# -- Options for manual page output ------------------------------------------
 
221
#latex_domain_indices = True
 
222
 
 
223
 
 
224
# -- Options for manual page output --------------------------------------------
256
225
 
257
226
# One entry per manual page. List of tuples
258
227
# (source start file, name, description, authors, manual section).
259
 
_authors = ['Zygmunt Krynicki & Checkbox Contributors']
260
228
man_pages = [
261
 
    # Section 1
262
 
    ('manpages/plainbox', 'plainbox',
263
 
     'toolkit for software and hardware integration testing',
264
 
     _authors, 1),
265
 
    ('manpages/plainbox-trusted-launcher-1', 'plainbox-trusted-launcher-1',
266
 
     'execute job command as another user', _authors, 1),
267
 
    ('manpages/plainbox-run', 'plainbox-run',
268
 
     'run a test job', _authors, 1),
269
 
    ('manpages/plainbox-check-config', 'plainbox-check-config',
270
 
     'check and display plainbox configuration', _authors, 1),
271
 
    ('manpages/plainbox-startprovider', 'plainbox-startprovider',
272
 
     'create a new plainbox provider', _authors, 1),
273
 
    ('manpages/plainbox-self-test', 'plainbox-self-test',
274
 
     'run unit and integration tests', _authors, 1),
275
 
    ('manpages/plainbox-manage.py', 'manage.py',
276
 
     'plainbox provider management script', _authors, 1),
277
 
    ('manpages/plainbox-session', 'plainbox-session',
278
 
     'session management sub-commands', _authors, 1),
279
 
    ('manpages/plainbox-session-list', 'plainbox-session-list',
280
 
     'list available session', _authors, 1),
281
 
    ('manpages/plainbox-session-remove', 'plainbox-session-remove',
282
 
     'remove one ore more sessions', _authors, 1),
283
 
    ('manpages/plainbox-session-show', 'plainbox-session-show',
284
 
     'show a single session', _authors, 1),
285
 
    ('manpages/plainbox-session-archive', 'plainbox-session-archive',
286
 
     'archive a single session', _authors, 1),
287
 
    ('manpages/plainbox-session-export', 'plainbox-session-export',
288
 
     '(re-)export an existing session', _authors, 1),
289
 
    ('manpages/plainbox-dev', 'plainbox-dev',
290
 
     'commands for test developers', _authors, 1),
291
 
    ('manpages/plainbox-dev-script', 'plainbox-dev-script',
292
 
     'run a command from a job', _authors, 1),
293
 
    ('manpages/plainbox-dev-special', 'plainbox-dev-special',
294
 
     'special/internal commands', _authors, 1),
295
 
    ('manpages/plainbox-dev-analyze', 'plainbox-dev-analyze',
296
 
     'analyze how seleted jobs would be executed', _authors, 1),
297
 
    ('manpages/plainbox-dev-parse', 'plainbox-dev-parse',
298
 
     'parse stdin with the specified parser', _authors, 1),
299
 
    ('manpages/plainbox-dev-crash', 'plainbox-dev-crash',
300
 
     'crash the application', _authors, 1),
301
 
    ('manpages/plainbox-dev-logtest', 'plainbox-dev-logtest',
302
 
     'log messages at various levels', _authors, 1),
303
 
    ('manpages/plainbox-dev-list', 'plainbox-dev-list',
304
 
     'list and describe various objects', _authors, 1),
305
 
    ('manpages/plainbox-device', 'plainbox-device',
306
 
     'device management commands', _authors, 1),
307
 
    ('manpages/plainbox-qml-shell', 'plainbox-qml-shell',
308
 
     'standalone qml-native shell', _authors, 1),
309
 
    # Section 5
310
 
    ('manpages/plainbox.conf', 'plainbox.conf',
311
 
     'plainbox configuration file', _authors, 5),
312
 
    # Section 7
313
 
    ('manpages/plainbox-session-structure', 'plainbox-session-structure',
314
 
     'structure of per-session directory', _authors, 7),
315
 
    ('manpages/plainbox-template-units', 'plainbox-template-units',
316
 
     'syntax and semantics of Plainbox template unit type', _authors, 7),
317
 
    ('manpages/plainbox-category-units', 'plainbox-category-units',
318
 
     'syntax and semantics of Plainbox category unit type', _authors, 7),
319
 
    ('manpages/plainbox-file-units', 'plainbox-file-units',
320
 
     'syntax and semantics of Plainbox file unit type', _authors, 7),
321
 
    ('manpages/plainbox-test-plan-units', 'plainbox-test-plan-units',
322
 
     'syntax and semantics of Plainbox test plan unit type', _authors, 7),
323
 
    ('manpages/plainbox-job-units', 'plainbox-job-units',
324
 
     'syntax and semantics of Plainbox job unit type', _authors, 7),
325
 
    ('manpages/plainbox-manifest-entry-units', 'plainbox-job-units',
326
 
     'syntax and semantics of Plainbox manifest entry unit type',
327
 
     _authors, 7),
328
 
    ('manpages/plainbox-exporter-units', 'plainbox-exporter-units',
329
 
     'syntax and semantics of Plainbox exporter unit type',
330
 
     _authors, 7),
331
 
    ('manpages/plainbox-packaging-meta-data-units',
332
 
     'plainbox-packaging-meta-data-units',
333
 
     'syntax and semantics of Plainbox package meta-data unit type',
334
 
     _authors, 7),
335
 
    ('manpages/PLAINBOX_SESSION_SHARE', 'PLAINBOX_SESSION_SHARE',
336
 
     'per-session runtime shared-state directory', _authors, 7),
337
 
    ('manpages/PLAINBOX_PROVIDER_DATA', 'PLAINBOX_PROVIDER_DATA',
338
 
     'per-provider data directory', _authors, 7),
339
 
    ('manpages/CHECKBOX_DATA', 'CHECKBOX_DATA',
340
 
     'legacy name for PLAINBOX_SESSION_SHARE', _authors, 7),
341
 
    ('manpages/CHECKBOX_SHARE', 'CHECKBOX_SHARE',
342
 
     'legacy name for PLAINBOX_PROVIDER_DATA', _authors, 7),
 
229
    ('index', 'plainbox', 'PlainBox Documentation',
 
230
     ['Zygmunt Krynicki'], 1)
343
231
]
344
232
 
345
233
# If true, show URL addresses after external links.
346
 
# man_show_urls = False
347
 
 
348
 
 
349
 
# -- Options for Texinfo output ----------------------------------------------
 
234
#man_show_urls = False
 
235
 
 
236
 
 
237
# -- Options for Texinfo output ------------------------------------------------
350
238
 
351
239
# Grouping the document tree into Texinfo files. List of tuples
352
240
# (source start file, target name, title, author,
353
241
#  dir menu entry, description, category)
354
242
texinfo_documents = [
355
 
    ('index', 'Plainbox', 'Plainbox Documentation',
356
 
     'Zygmunt Krynicki', 'Plainbox', 'One line description of project.',
357
 
     'Miscellaneous'),
 
243
  ('index', 'PlainBox', 'PlainBox Documentation',
 
244
   'Zygmunt Krynicki', 'PlainBox', 'One line description of project.',
 
245
   'Miscellaneous'),
358
246
]
359
247
 
360
248
# Documents to append as an appendix to all manuals.
361
 
# texinfo_appendices = []
 
249
#texinfo_appendices = []
362
250
 
363
251
# If false, no module index is generated.
364
 
# texinfo_domain_indices = True
 
252
#texinfo_domain_indices = True
365
253
 
366
254
# How to display URL addresses: 'footnote', 'no', or 'inline'.
367
 
# texinfo_show_urls = 'footnote'
 
255
#texinfo_show_urls = 'footnote'