3 # Python MPD Module documentation build configuration file, created by
4 # sphinx-quickstart on Mon Mar 12 14:37:32 2018.
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.
15 # If extensions (or modules to document with autodoc) are in another directory,
16 # add these directories to sys.path here. If the directory is relative to the
17 # documentation root, use os.path.abspath to make it absolute, like shown here.
21 sys.path.insert(0, os.path.abspath('../../'))
22 from musicpd import VERSION
24 # -- General configuration ------------------------------------------------
26 # If your documentation needs a minimal Sphinx version, state it here.
28 # needs_sphinx = '1.0'
30 # Add any Sphinx extension module names here, as strings. They can be
31 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
35 'sphinx.ext.intersphinx',
36 #'sphinx.ext.coverage',
37 'sphinx.ext.viewcode',
41 # Add any paths that contain templates here, relative to this directory.
42 templates_path = ['_templates']
44 # The suffix(es) of source filenames.
45 # 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.
52 # source_encoding = 'utf-8-sig'
54 # The master toctree document.
57 # General information about the project.
58 project = u'Python MPD Module'
59 copyright = u'2018, {}'.format(__author__)
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:
83 # Else, today_fmt is used as the format for a strftime call.
85 # today_fmt = '%B %d, %Y'
87 # List of patterns, relative to source directory, that match files and
88 # directories to ignore when looking for source files.
89 # This patterns also effect to html_static_path and html_extra_path
92 # The reST default role (used for this markup: `text`) to use for all
97 # If true, '()' will be appended to :func: etc. cross-reference text.
99 # add_function_parentheses = True
101 # If true, the current module name will be prepended to all description
102 # unit titles (such as .. function::).
104 # add_module_names = True
106 # If true, sectionauthor and moduleauthor directives will be shown in the
107 # output. They are ignored by default.
109 # show_authors = False
111 # The name of the Pygments (syntax highlighting) style to use.
112 pygments_style = 'sphinx'
114 # A list of ignored prefixes for module index sorting.
115 # modindex_common_prefix = []
117 # If true, keep warnings as "system message" paragraphs in the built documents.
118 # keep_warnings = False
120 # If true, `todo` and `todoList` produce output, else they produce nothing.
121 todo_include_todos = True
124 # -- Options for HTML output ----------------------------------------------
126 # The theme to use for HTML and HTML Help pages. See the documentation for
127 # a list of builtin themes.
129 html_theme = 'classic'
130 #html_theme = "sphinx_rtd_theme"
131 #html_theme = 'bootstrap'
133 # Theme options are theme-specific and customize the look and feel of a theme
134 # further. For a list of options available for each theme, see the
137 # html_theme_options = {}
139 # Add any paths that contain custom themes here, relative to this directory.
140 # html_theme_path = []
141 #html_theme_path = ['/usr/lib/python3/dist-packages/sphinx_bootstrap_theme']
143 # The name for this set of Sphinx documents.
144 # "<project> v<release> documentation" by default.
146 # html_title = u'Python MPD Module v0.0.1'
148 # A shorter title for the navigation bar. Default is the same as html_title.
150 # html_short_title = None
152 # The name of an image file (relative to this directory) to place at the top
157 # The name of an image file (relative to this directory) to use as a favicon of
158 # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
161 # html_favicon = None
163 # Add any paths that contain custom static files (such as style sheets) here,
164 # relative to this directory. They are copied after the builtin static files,
165 # so a file named "default.css" will overwrite the builtin "default.css".
166 #chtml_static_path = ['_static']
168 # Add any extra paths that contain custom files (such as robots.txt or
169 # .htaccess) here, relative to this directory. These files are copied
170 # directly to the root of the documentation.
172 # html_extra_path = []
174 # If not None, a 'Last updated on:' timestamp is inserted at every page
175 # bottom, using the given strftime format.
176 # The empty string is equivalent to '%b %d, %Y'.
178 # html_last_updated_fmt = None
180 # If true, SmartyPants will be used to convert quotes and dashes to
181 # typographically correct entities.
183 # html_use_smartypants = True
185 # Custom sidebar templates, maps document names to template names.
189 # Additional templates that should be rendered to pages, maps page names to
192 # html_additional_pages = {}
194 # If false, no module index is generated.
196 # html_domain_indices = True
198 # If false, no index is generated.
200 # html_use_index = True
202 # If true, the index is split into individual pages for each letter.
204 # html_split_index = False
206 # If true, links to the reST sources are added to the pages.
208 # html_show_sourcelink = True
210 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
212 # html_show_sphinx = True
213 html_show_sphinx = False
215 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
217 # html_show_copyright = True
219 # If true, an OpenSearch description file will be output, and all pages will
220 # contain a <link> tag referring to it. The value of this option must be the
221 # base URL from which the finished HTML is served.
223 # html_use_opensearch = ''
225 # This is the file name suffix for HTML files (e.g. ".xhtml").
226 # html_file_suffix = None
228 # Language to be used for generating the HTML full-text search index.
229 # Sphinx supports the following languages:
230 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
231 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
233 # html_search_language = 'en'
235 # A dictionary with options for the search language support, empty by default.
236 # 'ja' uses this config value.
237 # 'zh' user can custom change `jieba` dictionary path.
239 # html_search_options = {'type': 'default'}
241 # The name of a javascript file (relative to the configuration directory) that
242 # implements a search results scorer. If empty, the default will be used.
244 # html_search_scorer = 'scorer.js'
246 # Output file base name for HTML help builder.
247 htmlhelp_basename = 'PythonMPDModuledoc'
249 # -- Options for LaTeX output ---------------------------------------------
252 # The paper size ('letterpaper' or 'a4paper').
254 # 'papersize': 'letterpaper',
256 # The font size ('10pt', '11pt' or '12pt').
258 # 'pointsize': '10pt',
260 # Additional stuff for the LaTeX preamble.
264 # Latex figure (float) alignment
266 # 'figure_align': 'htbp',
269 # Grouping the document tree into LaTeX files. List of tuples
270 # (source start file, target name, title,
271 # author, documentclass [howto, manual, or own class]).
273 (master_doc, 'PythonMPDModule.tex', u'Python MPD Module Documentation',
274 u'kaliko', 'manual'),
277 # The name of an image file (relative to this directory) to place at the top of
282 # For "manual" documents, if this is true, then toplevel headings are parts,
285 # latex_use_parts = False
287 # If true, show page references after internal links.
289 # latex_show_pagerefs = False
291 # If true, show URL addresses after external links.
293 # latex_show_urls = False
295 # Documents to append as an appendix to all manuals.
297 # latex_appendices = []
299 # It false, will not define \strong, \code, itleref, \crossref ... but only
300 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
303 # latex_keep_old_macro_names = True
305 # If false, no module index is generated.
307 # latex_domain_indices = True
310 # -- Options for manual page output ---------------------------------------
312 # One entry per manual page. List of tuples
313 # (source start file, name, description, authors, manual section).
315 (master_doc, 'pythonmpdmodule', u'Python MPD Module Documentation',
319 # If true, show URL addresses after external links.
321 # man_show_urls = False
324 # -- Options for Texinfo output -------------------------------------------
326 # Grouping the document tree into Texinfo files. List of tuples
327 # (source start file, target name, title, author,
328 # dir menu entry, description, category)
329 texinfo_documents = [
330 (master_doc, 'PythonMPDModule', u'Python MPD Module Documentation',
331 author, 'PythonMPDModule', 'One line description of project.',
335 # Documents to append as an appendix to all manuals.
337 # texinfo_appendices = []
339 # If false, no module index is generated.
341 # texinfo_domain_indices = True
343 # How to display URL addresses: 'footnote', 'no', or 'inline'.
345 # texinfo_show_urls = 'footnote'
347 # If true, do not generate a @detailmenu in the "Top" node's menu.
349 # texinfo_no_detailmenu = False
352 # -- Options for Epub output ----------------------------------------------
354 # Bibliographic Dublin Core info.
357 epub_publisher = author
358 epub_copyright = copyright
360 # The basename for the epub file. It defaults to the project name.
361 # epub_basename = project
363 # The HTML theme for the epub output. Since the default themes are not
364 # optimized for small screen space, using the same theme for HTML and epub
365 # output is usually not wise. This defaults to 'epub', a theme designed to save
368 # epub_theme = 'epub'
370 # The language of the text. It defaults to the language option
371 # or 'en' if the language is not set.
375 # The scheme of the identifier. Typical schemes are ISBN or URL.
378 # The unique identifier of the text. This can be a ISBN number
379 # or the project homepage.
381 # epub_identifier = ''
383 # A unique identification for the text.
387 # A tuple containing the cover image and cover page html template filenames.
391 # A sequence of (type, uri, title) tuples for the guide element of content.opf.
395 # HTML files that should be inserted before the pages created by sphinx.
396 # The format is a list of tuples containing the path and title.
398 # epub_pre_files = []
400 # HTML files that should be inserted after the pages created by sphinx.
401 # The format is a list of tuples containing the path and title.
403 # epub_post_files = []
405 # A list of files that should not be packed into the epub file.
406 epub_exclude_files = ['search.html']
408 # The depth of the table of contents in toc.ncx.
412 # Allow duplicate toc entries.
416 # Choose between 'default' and 'includehidden'.
418 # epub_tocscope = 'default'
420 # Fix unsupported image types using the Pillow.
422 # epub_fix_images = False
424 # Scale large images.
426 # epub_max_image_width = 0
428 # How to display URL addresses: 'footnote', 'no', or 'inline'.
430 # epub_show_urls = 'inline'
432 # If false, no index is generated.
434 # epub_use_index = True
437 # Example configuration for intersphinx: refer to the Python standard library.
438 intersphinx_mapping = {'https://docs.python.org/': None}
441 autodoc_member_order = 'bysource'