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',
40 'sphinxcontrib.asyncio',
43 # Add any paths that contain templates here, relative to this directory.
44 templates_path
= ['_templates']
46 # The suffix(es) of source filenames.
47 # You can specify multiple suffix as a list of string:
48 # source_suffix = ['.rst', '.md']
49 source_suffix
= '.rst'
51 # The encoding of source files.
52 #source_encoding = 'utf-8-sig'
54 # The master toctree document.
57 # General information about the project.
59 copyright
= u
'2016, Canonical Ltd.'
62 # The version info for the project you're documenting, acts as replacement for
63 # |version| and |release|, also used in various other places throughout the
66 # The short X.Y version.
68 # The full version, including alpha/beta/rc tags.
71 # The language for content autogenerated by Sphinx. Refer to documentation
72 # for a list of supported languages.
74 # This is also used if you do content translation via gettext catalogs.
75 # Usually you set "language" from the command line for these cases.
78 # There are two options for replacing |today|: either, you set today to some
79 # non-false value, then it is used:
81 # Else, today_fmt is used as the format for a strftime call.
82 #today_fmt = '%B %d, %Y'
84 # List of patterns, relative to source directory, that match files and
85 # directories to ignore when looking for source files.
86 # This patterns also effect to html_static_path and html_extra_path
87 exclude_patterns
= ['_build', 'Thumbs.db', '.DS_Store']
89 # The reST default role (used for this markup: `text`) to use for all
93 # If true, '()' will be appended to :func: etc. cross-reference text.
94 #add_function_parentheses = True
96 # If true, the current module name will be prepended to all description
97 # unit titles (such as .. function::).
98 #add_module_names = True
100 # If true, sectionauthor and moduleauthor directives will be shown in the
101 # output. They are ignored by default.
102 #show_authors = False
104 # The name of the Pygments (syntax highlighting) style to use.
105 pygments_style
= 'sphinx'
107 # A list of ignored prefixes for module index sorting.
108 #modindex_common_prefix = []
110 # If true, keep warnings as "system message" paragraphs in the built documents.
111 #keep_warnings = False
113 # If true, `todo` and `todoList` produce output, else they produce nothing.
114 todo_include_todos
= True
117 # -- Options for HTML output ----------------------------------------------
119 # The theme to use for HTML and HTML Help pages. See the documentation for
120 # a list of builtin themes.
121 html_theme
= 'alabaster'
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
126 #html_theme_options = {}
128 # Add any paths that contain custom themes here, relative to this directory.
129 #html_theme_path = []
131 # The name for this set of Sphinx documents.
132 # "<project> v<release> documentation" by default.
133 #html_title = u'libjuju v0.0.0'
135 # A shorter title for the navigation bar. Default is the same as html_title.
136 #html_short_title = None
138 # The name of an image file (relative to this directory) to place at the top
142 # The name of an image file (relative to this directory) to use as a favicon of
143 # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
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']
152 # Add any extra paths that contain custom files (such as robots.txt or
153 # .htaccess) here, relative to this directory. These files are copied
154 # directly to the root of the documentation.
155 #html_extra_path = []
157 # If not None, a 'Last updated on:' timestamp is inserted at every page
158 # bottom, using the given strftime format.
159 # The empty string is equivalent to '%b %d, %Y'.
160 #html_last_updated_fmt = None
162 # If true, SmartyPants will be used to convert quotes and dashes to
163 # typographically correct entities.
164 #html_use_smartypants = True
166 # Custom sidebar templates, maps document names to template names.
169 # Additional templates that should be rendered to pages, maps page names to
171 #html_additional_pages = {}
173 # If false, no module index is generated.
174 #html_domain_indices = True
176 # If false, no index is generated.
177 #html_use_index = True
179 # If true, the index is split into individual pages for each letter.
180 #html_split_index = False
182 # If true, links to the reST sources are added to the pages.
183 #html_show_sourcelink = True
185 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
186 #html_show_sphinx = True
188 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
189 #html_show_copyright = True
191 # If true, an OpenSearch description file will be output, and all pages will
192 # contain a <link> tag referring to it. The value of this option must be the
193 # base URL from which the finished HTML is served.
194 #html_use_opensearch = ''
196 # This is the file name suffix for HTML files (e.g. ".xhtml").
197 #html_file_suffix = None
199 # Language to be used for generating the HTML full-text search index.
200 # Sphinx supports the following languages:
201 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
202 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
203 #html_search_language = 'en'
205 # A dictionary with options for the search language support, empty by default.
206 # 'ja' uses this config value.
207 # 'zh' user can custom change `jieba` dictionary path.
208 #html_search_options = {'type': 'default'}
210 # The name of a javascript file (relative to the configuration directory) that
211 # implements a search results scorer. If empty, the default will be used.
212 #html_search_scorer = 'scorer.js'
214 # Output file base name for HTML help builder.
215 htmlhelp_basename
= 'libjujudoc'
217 # -- Options for LaTeX output ---------------------------------------------
220 # The paper size ('letterpaper' or 'a4paper').
221 #'papersize': 'letterpaper',
223 # The font size ('10pt', '11pt' or '12pt').
224 #'pointsize': '10pt',
226 # Additional stuff for the LaTeX preamble.
229 # Latex figure (float) alignment
230 #'figure_align': 'htbp',
233 # Grouping the document tree into LaTeX files. List of tuples
234 # (source start file, target name, title,
235 # author, documentclass [howto, manual, or own class]).
237 (master_doc
, 'libjuju.tex', u
'libjuju Documentation',
238 u
'Canonical', 'manual'),
241 # The name of an image file (relative to this directory) to place at the top of
245 # For "manual" documents, if this is true, then toplevel headings are parts,
247 #latex_use_parts = False
249 # If true, show page references after internal links.
250 #latex_show_pagerefs = False
252 # If true, show URL addresses after external links.
253 #latex_show_urls = False
255 # Documents to append as an appendix to all manuals.
256 #latex_appendices = []
258 # If false, no module index is generated.
259 #latex_domain_indices = True
262 # -- Options for manual page output ---------------------------------------
264 # One entry per manual page. List of tuples
265 # (source start file, name, description, authors, manual section).
267 (master_doc
, 'libjuju', u
'libjuju Documentation',
271 # If true, show URL addresses after external links.
272 #man_show_urls = False
275 # -- Options for Texinfo output -------------------------------------------
277 # Grouping the document tree into Texinfo files. List of tuples
278 # (source start file, target name, title, author,
279 # dir menu entry, description, category)
280 texinfo_documents
= [
281 (master_doc
, 'libjuju', u
'libjuju Documentation',
282 author
, 'libjuju', 'One line description of project.',
286 # Documents to append as an appendix to all manuals.
287 #texinfo_appendices = []
289 # If false, no module index is generated.
290 #texinfo_domain_indices = True
292 # How to display URL addresses: 'footnote', 'no', or 'inline'.
293 #texinfo_show_urls = 'footnote'
295 # If true, do not generate a @detailmenu in the "Top" node's menu.
296 #texinfo_no_detailmenu = False