a856985762408a543ebc4ec12d5b7f701e60d37d
1 # -*- coding: utf-8 -*-
3 # libjuju documentation build configuration file, created by
4 # sphinx-quickstart on Thu May 19 11:21:38 2016.
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 from pathlib
import Path
20 here
= Path(__file__
).absolute().parent
21 version
= (here
.parent
/ 'VERSION').read_text().strip()
23 # If extensions (or modules to document with autodoc) are in another directory,
24 # add these directories to sys.path here. If the directory is relative to the
25 # documentation root, use os.path.abspath to make it absolute, like shown here.
26 sys
.path
.insert(0, os
.path
.abspath('..'))
28 # -- General configuration ------------------------------------------------
30 # If your documentation needs a minimal Sphinx version, state it here.
33 # Add any Sphinx extension module names here, as strings. They can be
34 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
39 'sphinx.ext.viewcode',
42 # Add any paths that contain templates here, relative to this directory.
43 templates_path
= ['_templates']
45 # The suffix(es) of source filenames.
46 # You can specify multiple suffix as a list of string:
47 # source_suffix = ['.rst', '.md']
48 source_suffix
= '.rst'
50 # The encoding of source files.
51 #source_encoding = 'utf-8-sig'
53 # The master toctree document.
56 # General information about the project.
58 copyright
= u
'2016, Canonical Ltd.'
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
65 # The short X.Y version.
67 # The full version, including alpha/beta/rc tags.
70 # The language for content autogenerated by Sphinx. Refer to documentation
71 # for a list of supported languages.
73 # This is also used if you do content translation via gettext catalogs.
74 # Usually you set "language" from the command line for these cases.
77 # There are two options for replacing |today|: either, you set today to some
78 # non-false value, then it is used:
80 # Else, today_fmt is used as the format for a strftime call.
81 #today_fmt = '%B %d, %Y'
83 # List of patterns, relative to source directory, that match files and
84 # directories to ignore when looking for source files.
85 # This patterns also effect to html_static_path and html_extra_path
86 exclude_patterns
= ['_build', 'Thumbs.db', '.DS_Store']
88 # The reST default role (used for this markup: `text`) to use for all
92 # If true, '()' will be appended to :func: etc. cross-reference text.
93 #add_function_parentheses = True
95 # If true, the current module name will be prepended to all description
96 # unit titles (such as .. function::).
97 #add_module_names = True
99 # If true, sectionauthor and moduleauthor directives will be shown in the
100 # output. They are ignored by default.
101 #show_authors = False
103 # The name of the Pygments (syntax highlighting) style to use.
104 pygments_style
= 'sphinx'
106 # A list of ignored prefixes for module index sorting.
107 #modindex_common_prefix = []
109 # If true, keep warnings as "system message" paragraphs in the built documents.
110 #keep_warnings = False
112 # If true, `todo` and `todoList` produce output, else they produce nothing.
113 todo_include_todos
= True
116 # -- Options for HTML output ----------------------------------------------
118 # The theme to use for HTML and HTML Help pages. See the documentation for
119 # a list of builtin themes.
120 html_theme
= 'alabaster'
122 # Theme options are theme-specific and customize the look and feel of a theme
123 # further. For a list of options available for each theme, see the
125 #html_theme_options = {}
127 # Add any paths that contain custom themes here, relative to this directory.
128 #html_theme_path = []
130 # The name for this set of Sphinx documents.
131 # "<project> v<release> documentation" by default.
132 #html_title = u'libjuju v0.0.0'
134 # A shorter title for the navigation bar. Default is the same as html_title.
135 #html_short_title = None
137 # The name of an image file (relative to this directory) to place at the top
141 # The name of an image file (relative to this directory) to use as a favicon of
142 # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
146 # Add any paths that contain custom static files (such as style sheets) here,
147 # relative to this directory. They are copied after the builtin static files,
148 # so a file named "default.css" will overwrite the builtin "default.css".
149 html_static_path
= ['_static']
151 # Add any extra paths that contain custom files (such as robots.txt or
152 # .htaccess) here, relative to this directory. These files are copied
153 # directly to the root of the documentation.
154 #html_extra_path = []
156 # If not None, a 'Last updated on:' timestamp is inserted at every page
157 # bottom, using the given strftime format.
158 # The empty string is equivalent to '%b %d, %Y'.
159 #html_last_updated_fmt = None
161 # If true, SmartyPants will be used to convert quotes and dashes to
162 # typographically correct entities.
163 #html_use_smartypants = True
165 # Custom sidebar templates, maps document names to template names.
168 # Additional templates that should be rendered to pages, maps page names to
170 #html_additional_pages = {}
172 # If false, no module index is generated.
173 #html_domain_indices = True
175 # If false, no index is generated.
176 #html_use_index = True
178 # If true, the index is split into individual pages for each letter.
179 #html_split_index = False
181 # If true, links to the reST sources are added to the pages.
182 #html_show_sourcelink = True
184 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
185 #html_show_sphinx = True
187 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
188 #html_show_copyright = True
190 # If true, an OpenSearch description file will be output, and all pages will
191 # contain a <link> tag referring to it. The value of this option must be the
192 # base URL from which the finished HTML is served.
193 #html_use_opensearch = ''
195 # This is the file name suffix for HTML files (e.g. ".xhtml").
196 #html_file_suffix = None
198 # Language to be used for generating the HTML full-text search index.
199 # Sphinx supports the following languages:
200 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
201 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
202 #html_search_language = 'en'
204 # A dictionary with options for the search language support, empty by default.
205 # 'ja' uses this config value.
206 # 'zh' user can custom change `jieba` dictionary path.
207 #html_search_options = {'type': 'default'}
209 # The name of a javascript file (relative to the configuration directory) that
210 # implements a search results scorer. If empty, the default will be used.
211 #html_search_scorer = 'scorer.js'
213 # Output file base name for HTML help builder.
214 htmlhelp_basename
= 'libjujudoc'
216 # -- Options for LaTeX output ---------------------------------------------
219 # The paper size ('letterpaper' or 'a4paper').
220 #'papersize': 'letterpaper',
222 # The font size ('10pt', '11pt' or '12pt').
223 #'pointsize': '10pt',
225 # Additional stuff for the LaTeX preamble.
228 # Latex figure (float) alignment
229 #'figure_align': 'htbp',
232 # Grouping the document tree into LaTeX files. List of tuples
233 # (source start file, target name, title,
234 # author, documentclass [howto, manual, or own class]).
236 (master_doc
, 'libjuju.tex', u
'libjuju Documentation',
237 u
'Canonical', 'manual'),
240 # The name of an image file (relative to this directory) to place at the top of
244 # For "manual" documents, if this is true, then toplevel headings are parts,
246 #latex_use_parts = False
248 # If true, show page references after internal links.
249 #latex_show_pagerefs = False
251 # If true, show URL addresses after external links.
252 #latex_show_urls = False
254 # Documents to append as an appendix to all manuals.
255 #latex_appendices = []
257 # If false, no module index is generated.
258 #latex_domain_indices = True
261 # -- Options for manual page output ---------------------------------------
263 # One entry per manual page. List of tuples
264 # (source start file, name, description, authors, manual section).
266 (master_doc
, 'libjuju', u
'libjuju Documentation',
270 # If true, show URL addresses after external links.
271 #man_show_urls = False
274 # -- Options for Texinfo output -------------------------------------------
276 # Grouping the document tree into Texinfo files. List of tuples
277 # (source start file, target name, title, author,
278 # dir menu entry, description, category)
279 texinfo_documents
= [
280 (master_doc
, 'libjuju', u
'libjuju Documentation',
281 author
, 'libjuju', 'One line description of project.',
285 # Documents to append as an appendix to all manuals.
286 #texinfo_appendices = []
288 # If false, no module index is generated.
289 #texinfo_domain_indices = True
291 # How to display URL addresses: 'footnote', 'no', or 'inline'.
292 #texinfo_show_urls = 'footnote'
294 # If true, do not generate a @detailmenu in the "Top" node's menu.
295 #texinfo_no_detailmenu = False