« back to all changes in this revision
Viewing changes to docs/conf.py
- browse files at revision 1
- compare with another revision
- download diff
- download tarball
- view history from revision 1
- Committer: Package Import Robot
- Author(s): Sylvain Pineau
- Date: 2014-01-21 21:18:23 UTC
- Revision ID: package-import@ubuntu.com-20140121211823-iru2ukliuatzpo5p
Tags: upstream-0.1
Import upstream version 0.1
- files added:
- checkbox_ng
- checkbox_ng.egg-info
- checkbox_ng/commands
- checkbox_ng/dbus_ex
- contrib
- docs
- docs/scripts
added
removed
docs/conf.py
1
#!/usr/bin/env python3
2
# -*- coding: utf-8 -*-
3
#
4
# CheckBoxNG documentation build configuration file, created by
5
# sphinx-quickstart on Wed Feb 13 11:18:39 2013.
6
#
7
# This file is execfile()d with the current directory set to its 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
15
import sys, os
16
17
try:
18
import plainbox
19
except ImportError as exc:
20
raise SystemExit("plainbox has to be importable")
21
else:
22
# Inject mock modules so that we can build the
23
# documentation without having the real stuff available
24
from plainbox.vendor import mock
25
for mod_name in ['lxml', 'xlsxwriter', 'requests', 'requests.exceptions',
26
'dbus', 'dbus.lowlevel', 'dbus.exceptions',
27
'dbus._compat', 'dbus.service', '_dbus_bindings']:
28
sys.modules[mod_name] = mock.Mock()
29
print("Mocked {}".format(mod_name))
30
31
# If extensions (or modules to document with autodoc) are in another directory,
32
# add these directories to sys.path here. If the directory is relative to the
33
# documentation root, use os.path.abspath to make it absolute, like shown here.
34
#sys.path.insert(0, os.path.abspath('.'))
35
36
# -- General configuration -----------------------------------------------------
37
38
# If your documentation needs a minimal Sphinx version, state it here.
39
#needs_sphinx = '1.0'
40
41
# Add any Sphinx extension module names here, as strings. They can be extensions
42
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
43
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']
44
45
# Add any paths that contain templates here, relative to this directory.
46
templates_path = ['_templates']
47
48
# The suffix of source filenames.
49
source_suffix = '.rst'
50
51
# The encoding of source files.
52
#source_encoding = 'utf-8-sig'
53
54
# The master toctree document.
55
master_doc = 'index'
56
57
# General information about the project.
58
project = 'CheckBoxNG'
59
copyright = '2013, Zygmunt Krynicki'
60
61
# The version info for the project you're documenting, acts as replacement for
62
# |version| and |release|, also used in various other places throughout the
63
# built documents.
64
#
65
# The short X.Y version.
66
version = '0.1'
67
# The full version, including alpha/beta/rc tags.
68
release = '0.1'
69
70
# The language for content autogenerated by Sphinx. Refer to documentation
71
# for a list of supported languages.
72
#language = None
73
74
# There are two options for replacing |today|: either, you set today to some
75
# non-false value, then it is used:
76
#today = ''
77
# Else, today_fmt is used as the format for a strftime call.
78
#today_fmt = '%B %d, %Y'
79
80
# List of patterns, relative to source directory, that match files and
81
# directories to ignore when looking for source files.
82
exclude_patterns = []
83
84
# The reST default role (used for this markup: `text`) to use for all documents.
85
#default_role = None
86
87
# If true, '()' will be appended to :func: etc. cross-reference text.
88
#add_function_parentheses = True
89
90
# If true, the current module name will be prepended to all description
91
# unit titles (such as .. function::).
92
#add_module_names = True
93
94
# If true, sectionauthor and moduleauthor directives will be shown in the
95
# output. They are ignored by default.
96
#show_authors = False
97
98
# The name of the Pygments (syntax highlighting) style to use.
99
pygments_style = 'sphinx'
100
101
# A list of ignored prefixes for module index sorting.
102
#modindex_common_prefix = []
103
104
105
# -- Options for HTML output ---------------------------------------------------
106
107
try:
108
import sphinx_bootstrap_theme
109
except ImportError:
110
html_theme = 'default'
111
html_theme_options = {}
112
else:
113
html_theme = 'bootstrap'
114
html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
115
html_theme_options = {
116
'bootswatch_theme': 'united',
117
'navbar_class': "navbar navbar-inverse",
118
}
119
120
# The theme to use for HTML and HTML Help pages. See the documentation for
121
# a list of builtin themes.
122
123
# Theme options are theme-specific and customize the look and feel of a theme
124
# further. For a list of options available for each theme, see the
125
# documentation.
126
#html_theme_options = {}
127
128
# Add any paths that contain custom themes here, relative to this directory.
129
#html_theme_path = []
130
131
# The name for this set of Sphinx documents. If None, it defaults to
132
# "<project> v<release> documentation".
133
#html_title = None
134
135
# A shorter title for the navigation bar. Default is the same as html_title.
136
#html_short_title = None
137
138
# The name of an image file (relative to this directory) to place at the top
139
# of the sidebar.
140
#html_logo = None
141
142
# The name of an image file (within the static path) to use as favicon of the
143
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
144
# pixels large.
145
#html_favicon = None
146
147
# Add any paths that contain custom static files (such as style sheets) here,
148
# relative to this directory. They are copied after the builtin static files,
149
# so a file named "default.css" will overwrite the builtin "default.css".
150
html_static_path = ['_static']
151
152
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
153
# using the given strftime format.
154
#html_last_updated_fmt = '%b %d, %Y'
155
156
# If true, SmartyPants will be used to convert quotes and dashes to
157
# typographically correct entities.
158
#html_use_smartypants = True
159
160
# Custom sidebar templates, maps document names to template names.
161
#html_sidebars = {}
162
163
# Additional templates that should be rendered to pages, maps page names to
164
# template names.
165
#html_additional_pages = {}
166
167
# If false, no module index is generated.
168
#html_domain_indices = True
169
170
# If false, no index is generated.
171
#html_use_index = True
172
173
# If true, the index is split into individual pages for each letter.
174
#html_split_index = False
175
176
# If true, links to the reST sources are added to the pages.
177
#html_show_sourcelink = True
178
179
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
180
#html_show_sphinx = True
181
182
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
183
#html_show_copyright = True
184
185
# If true, an OpenSearch description file will be output, and all pages will
186
# contain a <link> tag referring to it. The value of this option must be the
187
# base URL from which the finished HTML is served.
188
#html_use_opensearch = ''
189
190
# This is the file name suffix for HTML files (e.g. ".xhtml").
191
#html_file_suffix = None
192
193
# Output file base name for HTML help builder.
194
htmlhelp_basename = 'CheckBoxNGdoc'
195
196
197
# -- Options for LaTeX output --------------------------------------------------
198
199
latex_elements = {
200
# The paper size ('letterpaper' or 'a4paper').
201
#'papersize': 'letterpaper',
202
203
# The font size ('10pt', '11pt' or '12pt').
204
#'pointsize': '10pt',
205
206
# Additional stuff for the LaTeX preamble.
207
#'preamble': '',
208
}
209
210
# Grouping the document tree into LaTeX files. List of tuples
211
# (source start file, target name, title, author, documentclass [howto/manual]).
212
latex_documents = [
213
('index', 'CheckBoxNG.tex', 'CheckBoxNG Documentation',
214
'Zygmunt Krynicki', 'manual'),
215
]
216
217
# The name of an image file (relative to this directory) to place at the top of
218
# the title page.
219
#latex_logo = None
220
221
# For "manual" documents, if this is true, then toplevel headings are parts,
222
# not chapters.
223
#latex_use_parts = False
224
225
# If true, show page references after internal links.
226
#latex_show_pagerefs = False
227
228
# If true, show URL addresses after external links.
229
#latex_show_urls = False
230
231
# Documents to append as an appendix to all manuals.
232
#latex_appendices = []
233
234
# If false, no module index is generated.
235
#latex_domain_indices = True
236
237
238
# -- Options for manual page output --------------------------------------------
239
240
# One entry per manual page. List of tuples
241
# (source start file, name, description, authors, manual section).
242
man_pages = [
243
('index', 'checkbox_ng', 'CheckBoxNG Documentation',
244
['Zygmunt Krynicki'], 1)
245
]
246
247
# If true, show URL addresses after external links.
248
#man_show_urls = False
249
250
251
# -- Options for Texinfo output ------------------------------------------------
252
253
# Grouping the document tree into Texinfo files. List of tuples
254
# (source start file, target name, title, author,
255
# dir menu entry, description, category)
256
texinfo_documents = [
257
('index', 'CheckBoxNG', 'CheckBoxNG Documentation',
258
'Zygmunt Krynicki', 'CheckBoxNG', 'One line description of project.',
259
'Miscellaneous'),
260
]
261
262
# Documents to append as an appendix to all manuals.
263
#texinfo_appendices = []
264
265
# If false, no module index is generated.
266
#texinfo_domain_indices = True
267
268
# How to display URL addresses: 'footnote', 'no', or 'inline'.
269
#texinfo_show_urls = 'footnote'
Loggerhead is a web-based interface for Breezy
Version: 2.0.1