1
# -*- coding: utf-8 -*-
3
# juju documentation build configuration file, created by
4
# sphinx-quickstart on Wed Jul 14 09:40:34 2010.
6
# This file is execfile()d with the current directory set to its containing dir.
8
# Note that not all possible configuration values are present in this
11
# All configuration values have a default; values that are commented out
12
# serve to show the default.
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
sys.path.insert(0, os.path.abspath('../..'))
21
# -- General configuration -----------------------------------------------------
23
# If your documentation needs a minimal Sphinx version, state it here.
26
# Add any Sphinx extension module names here, as strings. They can be extensions
27
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
30
extensions = ['sphinx.ext.autodoc']
32
if [int(x) for x in sphinx.__version__.split(".")] > [1, 0]:
33
if "singlehtml" not in sys.argv:
34
# singlehtml builder skips the step that would cause the _modules
35
# directory to be created, so source links don't work
36
extensions.append('sphinx.ext.viewcode')
38
# Add any paths that contain templates here, relative to this directory.
39
templates_path = ['_templates']
41
# The suffix of source filenames.
42
source_suffix = '.rst'
44
# The encoding of source files.
45
#source_encoding = 'utf-8-sig'
47
# The master toctree document.
50
# General information about the project.
52
copyright = u'2012, Canonical'
54
# The version info for the project you're documenting, acts as replacement for
55
# |version| and |release|, also used in various other places throughout the
58
# The short X.Y version.
60
# The full version, including alpha/beta/rc tags.
61
release = '0.5.0+bzr540'
63
# The language for content autogenerated by Sphinx. Refer to documentation
64
# for a list of supported languages.
67
# There are two options for replacing |today|: either, you set today to some
68
# non-false value, then it is used:
70
# Else, today_fmt is used as the format for a strftime call.
71
today_fmt = '%B %d, %Y'
73
# List of patterns, relative to source directory, that match files and
74
# directories to ignore when looking for source files.
77
# The reST default role (used for this markup: `text`) to use for all documents.
80
# If true, '()' will be appended to :func: etc. cross-reference text.
81
#add_function_parentheses = True
83
# If true, the current module name will be prepended to all description
84
# unit titles (such as .. function::).
85
#add_module_names = True
87
# If true, sectionauthor and moduleauthor directives will be shown in the
88
# output. They are ignored by default.
91
# The name of the Pygments (syntax highlighting) style to use.
92
pygments_style = 'sphinx'
94
# A list of ignored prefixes for module index sorting.
95
#modindex_common_prefix = []
98
# -- Options for HTML output ---------------------------------------------------
100
sys.path.append(os.path.abspath('_templates'))
101
html_theme_path = ['_templates']
102
html_theme = 'ubuntu1204'
105
html_short_title = "juju"
107
## should be 32x32 , left out for now until the header is updated to new guidelines
108
#html_logo = "juju_small.png"
111
html_static_path = ['_static']
112
html_last_updated_fmt = '%b %d, %Y'
113
html_use_smartypants = False
115
# Custom sidebar templates, maps document names to template names.
117
# 'index': 'project-links.html'
120
# Additional templates that should be rendered to pages, maps page names to
122
#html_additional_pages = {}
124
# If false, no module index is generated.
125
#html_domain_indices = False
127
# If false, no index is generated.
128
#html_use_index = True
130
# If true, the index is split into individual pages for each letter.
131
#html_split_index = False
133
# If true, links to the reST sources are added to the pages.
134
#html_show_sourcelink = True
136
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
137
html_show_sphinx = True
139
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
140
html_show_copyright = True
142
# If true, an OpenSearch description file will be output, and all pages will
143
# contain a <link> tag referring to it. The value of this option must be the
144
# base URL from which the finished HTML is served.
145
#html_use_opensearch = ''
147
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
148
html_file_suffix = '.html'
150
# Output file base name for HTML help builder.
151
htmlhelp_basename = 'jujudoc'
154
# -- Options for LaTeX output --------------------------------------------------
156
# The paper size ('letter' or 'a4').
157
#latex_paper_size = 'letter'
159
# The font size ('10pt', '11pt' or '12pt').
160
#latex_font_size = '10pt'
162
# Grouping the document tree into LaTeX files. List of tuples
163
# (source start file, target name, title, author, documentclass [howto/manual]).
165
('index', 'juju.tex', u'juju documentation',
166
u'Canonical', 'manual'),
169
# The name of an image file (relative to this directory) to place at the top of
173
# For "manual" documents, if this is true, then toplevel headings are parts,
175
#latex_use_parts = False
177
# If true, show page references after internal links.
178
#latex_show_pagerefs = False
180
# If true, show URL addresses after external links.
181
#latex_show_urls = False
183
# Additional stuff for the LaTeX preamble.
186
# Documents to append as an appendix to all manuals.
187
#latex_appendices = []
189
# If false, no module index is generated.
190
latex_domain_indices = False
193
# -- Options for manual page output --------------------------------------------
195
# One entry per manual page. List of tuples
196
# (source start file, name, description, authors, manual section).
198
('index', 'juju', u'juju documentation',
added
removed
conf.py
