1
# -*- coding: utf-8 -*-
3
# Charm Helpers documentation build configuration file, created by
4
# sphinx-quickstart on Fri Jun 6 10:34:44 2014.
6
# This file is execfile()d with the current directory set to its
9
# Note that not all possible configuration values are present in this
12
# All configuration values have a default; values that are commented out
13
# serve to show the default.
18
# If extensions (or modules to document with autodoc) are in another directory,
19
# add these directories to sys.path here. If the directory is relative to the
20
# documentation root, use os.path.abspath to make it absolute, like shown here.
21
sys.path.insert(0, os.path.abspath('../'))
23
# -- General configuration ------------------------------------------------
25
# If your documentation needs a minimal Sphinx version, state it here.
28
# Add any Sphinx extension module names here, as strings. They can be
29
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
35
# Add any paths that contain templates here, relative to this directory.
36
templates_path = ['_templates']
38
# The suffix of source filenames.
39
source_suffix = '.rst'
41
# The encoding of source files.
42
#source_encoding = 'utf-8-sig'
44
# The master toctree document.
47
# General information about the project.
48
project = u'Charm Helpers'
49
copyright = u'2014, Canonical Ltd.'
51
# The version info for the project you're documenting, acts as replacement for
52
# |version| and |release|, also used in various other places throughout the
55
# The short X.Y version.
57
# The full version, including alpha/beta/rc tags.
60
# The language for content autogenerated by Sphinx. Refer to documentation
61
# for a list of supported languages.
64
# There are two options for replacing |today|: either, you set today to some
65
# non-false value, then it is used:
67
# Else, today_fmt is used as the format for a strftime call.
68
#today_fmt = '%B %d, %Y'
70
# List of patterns, relative to source directory, that match files and
71
# directories to ignore when looking for source files.
72
exclude_patterns = ['_build']
74
# The reST default role (used for this markup: `text`) to use for all
78
# If true, '()' will be appended to :func: etc. cross-reference text.
79
#add_function_parentheses = True
81
# If true, the current module name will be prepended to all description
82
# unit titles (such as .. function::).
83
#add_module_names = True
85
# If true, sectionauthor and moduleauthor directives will be shown in the
86
# output. They are ignored by default.
89
# The name of the Pygments (syntax highlighting) style to use.
90
pygments_style = 'sphinx'
92
# A list of ignored prefixes for module index sorting.
93
#modindex_common_prefix = []
95
# If true, keep warnings as "system message" paragraphs in the built documents.
96
#keep_warnings = False
99
# -- Options for HTML output ----------------------------------------------
101
# The theme to use for HTML and HTML Help pages. See the documentation for
102
# a list of builtin themes.
103
html_theme = 'sphinx_rtd_theme'
105
# Theme options are theme-specific and customize the look and feel of a theme
106
# further. For a list of options available for each theme, see the
108
#html_theme_options = {}
110
# Add any paths that contain custom themes here, relative to this directory.
111
html_theme_path = ['_themes']
113
# The name for this set of Sphinx documents. If None, it defaults to
114
# "<project> v<release> documentation".
117
# A shorter title for the navigation bar. Default is the same as html_title.
118
#html_short_title = None
120
# The name of an image file (relative to this directory) to place at the top
124
# The name of an image file (within the static path) to use as favicon of the
125
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
129
# Add any paths that contain custom static files (such as style sheets) here,
130
# relative to this directory. They are copied after the builtin static files,
131
# so a file named "default.css" will overwrite the builtin "default.css".
132
html_static_path = ['_static']
134
# Add any extra paths that contain custom files (such as robots.txt or
135
# .htaccess) here, relative to this directory. These files are copied
136
# directly to the root of the documentation.
137
#html_extra_path = []
139
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
140
# using the given strftime format.
141
#html_last_updated_fmt = '%b %d, %Y'
143
# If true, SmartyPants will be used to convert quotes and dashes to
144
# typographically correct entities.
145
#html_use_smartypants = True
147
# Custom sidebar templates, maps document names to template names.
150
# Additional templates that should be rendered to pages, maps page names to
152
#html_additional_pages = {}
154
# If false, no module index is generated.
155
#html_domain_indices = True
157
# If false, no index is generated.
158
#html_use_index = True
160
# If true, the index is split into individual pages for each letter.
161
#html_split_index = False
163
# If true, links to the reST sources are added to the pages.
164
#html_show_sourcelink = True
166
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
167
#html_show_sphinx = True
169
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
170
#html_show_copyright = True
172
# If true, an OpenSearch description file will be output, and all pages will
173
# contain a <link> tag referring to it. The value of this option must be the
174
# base URL from which the finished HTML is served.
175
#html_use_opensearch = ''
177
# This is the file name suffix for HTML files (e.g. ".xhtml").
178
#html_file_suffix = None
180
# Output file base name for HTML help builder.
181
htmlhelp_basename = 'CharmHelpersdoc'
184
# -- Options for LaTeX output ---------------------------------------------
187
# The paper size ('letterpaper' or 'a4paper').
188
#'papersize': 'letterpaper',
190
# The font size ('10pt', '11pt' or '12pt').
191
#'pointsize': '10pt',
193
# Additional stuff for the LaTeX preamble.
197
# Grouping the document tree into LaTeX files. List of tuples
198
# (source start file, target name, title,
199
# author, documentclass [howto, manual, or own class]).
201
('index', 'CharmHelpers.tex', u'Charm Helpers Documentation',
202
u'Charm Helpers Developers', 'manual'),
205
# The name of an image file (relative to this directory) to place at the top of
209
# For "manual" documents, if this is true, then toplevel headings are parts,
211
#latex_use_parts = False
213
# If true, show page references after internal links.
214
#latex_show_pagerefs = False
216
# If true, show URL addresses after external links.
217
#latex_show_urls = False
219
# Documents to append as an appendix to all manuals.
220
#latex_appendices = []
222
# If false, no module index is generated.
223
#latex_domain_indices = True
226
# -- Options for manual page output ---------------------------------------
228
# One entry per manual page. List of tuples
229
# (source start file, name, description, authors, manual section).
231
('index', 'charmhelpers', u'Charm Helpers Documentation',
232
[u'Charm Helpers Developers'], 1)
235
# If true, show URL addresses after external links.
236
#man_show_urls = False
239
# -- Options for Texinfo output -------------------------------------------
241
# Grouping the document tree into Texinfo files. List of tuples
242
# (source start file, target name, title, author,
243
# dir menu entry, description, category)
244
texinfo_documents = [
245
('index', 'CharmHelpers', u'Charm Helpers Documentation',
246
u'Charm Helpers Developers', 'CharmHelpers', 'One line description of project.',
250
# Documents to append as an appendix to all manuals.
251
#texinfo_appendices = []
253
# If false, no module index is generated.
254
#texinfo_domain_indices = True
256
# How to display URL addresses: 'footnote', 'no', or 'inline'.
257
#texinfo_show_urls = 'footnote'
259
# If true, do not generate a @detailmenu in the "Top" node's menu.
260
#texinfo_no_detailmenu = False