← Back to branch summary

~sylvain-pineau/cdts/bug1214914

« back to all changes in this revision

Viewing changes to checkbox-ng/docs/conf.py

  • Committer: Zygmunt Krynicki
  • Date: 2013-05-17 13:54:25 UTC
  • mto: This revision was merged to the branch mainline in revision 2130.
  • Revision ID: zygmunt.krynicki@canonical.com-20130517135425-cxcenxx5t0qrtbxd
checkbox-ng: add CheckBoxNG sub-project

CheckBoxNG (or lowercase as checkbox-ng, pypi:checkbox-ng) is a clean
implementation of CheckBox on top of PlainBox. It provides a new
executable, 'checkbox' that has some of the same commands that were
previously implemented in the plainbox package.

In particular CheckBoxNG comes with the 'checkbox sru' command
(the same one as in plainbox). Later on this sub-command will be removed
from plainbox.

CheckBoxNG depends on plainbox >= 0.3

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com>

Show diffs side-by-side

added added

removed removed

Lines of Context:
checkbox-ng/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
# 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 -----------------------------------------------------
 
23
 
 
24
# If your documentation needs a minimal Sphinx version, state it here.
 
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']
 
30
 
 
31
# Add any paths that contain templates here, relative to this directory.
 
32
templates_path = ['_templates']
 
33
 
 
34
# The suffix of source filenames.
 
35
source_suffix = '.rst'
 
36
 
 
37
# The encoding of source files.
 
38
#source_encoding = 'utf-8-sig'
 
39
 
 
40
# The master toctree document.
 
41
master_doc = 'index'
 
42
 
 
43
# General information about the project.
 
44
project = 'CheckBoxNG'
 
45
copyright = '2013, Zygmunt Krynicki'
 
46
 
 
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 = '0.1'
 
53
# The full version, including alpha/beta/rc tags.
 
54
release = '0.1'
 
55
 
 
56
# The language for content autogenerated by Sphinx. Refer to documentation
 
57
# for a list of supported languages.
 
58
#language = None
 
59
 
 
60
# There are two options for replacing |today|: either, you set today to some
 
61
# non-false value, then it is used:
 
62
#today = ''
 
63
# Else, today_fmt is used as the format for a strftime call.
 
64
#today_fmt = '%B %d, %Y'
 
65
 
 
66
# List of patterns, relative to source directory, that match files and
 
67
# directories to ignore when looking for source files.
 
68
exclude_patterns = []
 
69
 
 
70
# The reST default role (used for this markup: `text`) to use for all documents.
 
71
#default_role = None
 
72
 
 
73
# If true, '()' will be appended to :func: etc. cross-reference text.
 
74
#add_function_parentheses = True
 
75
 
 
76
# If true, the current module name will be prepended to all description
 
77
# unit titles (such as .. function::).
 
78
#add_module_names = True
 
79
 
 
80
# If true, sectionauthor and moduleauthor directives will be shown in the
 
81
# output. They are ignored by default.
 
82
#show_authors = False
 
83
 
 
84
# The name of the Pygments (syntax highlighting) style to use.
 
85
pygments_style = 'sphinx'
 
86
 
 
87
# A list of ignored prefixes for module index sorting.
 
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
    }
 
105
 
 
106
# The theme to use for HTML and HTML Help pages.  See the documentation for
 
107
# a list of builtin themes.
 
108
 
 
109
# Theme options are theme-specific and customize the look and feel of a theme
 
110
# further.  For a list of options available for each theme, see the
 
111
# documentation.
 
112
#html_theme_options = {}
 
113
 
 
114
# Add any paths that contain custom themes here, relative to this directory.
 
115
#html_theme_path = []
 
116
 
 
117
# The name for this set of Sphinx documents.  If None, it defaults to
 
118
# "<project> v<release> documentation".
 
119
#html_title = None
 
120
 
 
121
# A shorter title for the navigation bar.  Default is the same as html_title.
 
122
#html_short_title = None
 
123
 
 
124
# The name of an image file (relative to this directory) to place at the top
 
125
# of the sidebar.
 
126
#html_logo = None
 
127
 
 
128
# The name of an image file (within the static path) to use as favicon of the
 
129
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 
130
# pixels large.
 
131
#html_favicon = None
 
132
 
 
133
# Add any paths that contain custom static files (such as style sheets) here,
 
134
# relative to this directory. They are copied after the builtin static files,
 
135
# so a file named "default.css" will overwrite the builtin "default.css".
 
136
html_static_path = ['_static']
 
137
 
 
138
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 
139
# using the given strftime format.
 
140
#html_last_updated_fmt = '%b %d, %Y'
 
141
 
 
142
# If true, SmartyPants will be used to convert quotes and dashes to
 
143
# typographically correct entities.
 
144
#html_use_smartypants = True
 
145
 
 
146
# Custom sidebar templates, maps document names to template names.
 
147
#html_sidebars = {}
 
148
 
 
149
# Additional templates that should be rendered to pages, maps page names to
 
150
# template names.
 
151
#html_additional_pages = {}
 
152
 
 
153
# If false, no module index is generated.
 
154
#html_domain_indices = True
 
155
 
 
156
# If false, no index is generated.
 
157
#html_use_index = True
 
158
 
 
159
# If true, the index is split into individual pages for each letter.
 
160
#html_split_index = False
 
161
 
 
162
# If true, links to the reST sources are added to the pages.
 
163
#html_show_sourcelink = True
 
164
 
 
165
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 
166
#html_show_sphinx = True
 
167
 
 
168
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
 
169
#html_show_copyright = True
 
170
 
 
171
# If true, an OpenSearch description file will be output, and all pages will
 
172
# contain a <link> tag referring to it.  The value of this option must be the
 
173
# base URL from which the finished HTML is served.
 
174
#html_use_opensearch = ''
 
175
 
 
176
# This is the file name suffix for HTML files (e.g. ".xhtml").
 
177
#html_file_suffix = None
 
178
 
 
179
# Output file base name for HTML help builder.
 
180
htmlhelp_basename = 'CheckBoxNGdoc'
 
181
 
 
182
 
 
183
# -- Options for LaTeX output --------------------------------------------------
 
184
 
 
185
latex_elements = {
 
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': '',
 
194
}
 
195
 
 
196
# Grouping the document tree into LaTeX files. List of tuples
 
197
# (source start file, target name, title, author, documentclass [howto/manual]).
 
198
latex_documents = [
 
199
  ('index', 'CheckBoxNG.tex', 'CheckBoxNG Documentation',
 
200
   'Zygmunt Krynicki', 'manual'),
 
201
]
 
202
 
 
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
 
206
 
 
207
# For "manual" documents, if this is true, then toplevel headings are parts,
 
208
# not chapters.
 
209
#latex_use_parts = False
 
210
 
 
211
# If true, show page references after internal links.
 
212
#latex_show_pagerefs = False
 
213
 
 
214
# If true, show URL addresses after external links.
 
215
#latex_show_urls = False
 
216
 
 
217
# Documents to append as an appendix to all manuals.
 
218
#latex_appendices = []
 
219
 
 
220
# If false, no module index is generated.
 
221
#latex_domain_indices = True
 
222
 
 
223
 
 
224
# -- Options for manual page output --------------------------------------------
 
225
 
 
226
# One entry per manual page. List of tuples
 
227
# (source start file, name, description, authors, manual section).
 
228
man_pages = [
 
229
    ('index', 'checkbox_ng', 'CheckBoxNG Documentation',
 
230
     ['Zygmunt Krynicki'], 1)
 
231
]
 
232
 
 
233
# If true, show URL addresses after external links.
 
234
#man_show_urls = False
 
235
 
 
236
 
 
237
# -- Options for Texinfo output ------------------------------------------------
 
238
 
 
239
# Grouping the document tree into Texinfo files. List of tuples
 
240
# (source start file, target name, title, author,
 
241
#  dir menu entry, description, category)
 
242
texinfo_documents = [
 
243
  ('index', 'CheckBoxNG', 'CheckBoxNG Documentation',
 
244
   'Zygmunt Krynicki', 'CheckBoxNG', 'One line description of project.',
 
245
   'Miscellaneous'),
 
246
]
 
247
 
 
248
# Documents to append as an appendix to all manuals.
 
249
#texinfo_appendices = []
 
250
 
 
251
# If false, no module index is generated.
 
252
#texinfo_domain_indices = True
 
253
 
 
254
# How to display URL addresses: 'footnote', 'no', or 'inline'.
 
255
#texinfo_show_urls = 'footnote'