3 # Python ListenBrainz 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 sys.path.insert(0, os.path.abspath('../../'))
23 from musicpd import VERSION
25 # -- General configuration ------------------------------------------------
27 # If your documentation needs a minimal Sphinx version, state it here.
29 # needs_sphinx = '1.0'
31 # Add any Sphinx extension module names here, as strings. They can be
32 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
36 'sphinx.ext.intersphinx',
37 #'sphinx.ext.coverage',
38 '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:
48 # source_suffix = ['.rst', '.md']
49 source_suffix = '.rst'
51 # The encoding of source files.
53 # source_encoding = 'utf-8-sig'
55 # The master toctree document.
58 # General information about the project.
59 project = u'Python ListenBrainz Module'
60 copyright = u'2018, {}'.format(__author__)
63 # The version info for the project you're documenting, acts as replacement for
64 # |version| and |release|, also used in various other places throughout the
67 # The short X.Y version.
69 # The full version, including alpha/beta/rc tags.
72 # The language for content autogenerated by Sphinx. Refer to documentation
73 # for a list of supported languages.
75 # This is also used if you do content translation via gettext catalogs.
76 # Usually you set "language" from the command line for these cases.
79 # There are two options for replacing |today|: either, you set today to some
80 # non-false value, then it is used:
84 # Else, today_fmt is used as the format for a strftime call.
86 # today_fmt = '%B %d, %Y'
88 # List of patterns, relative to source directory, that match files and
89 # directories to ignore when looking for source files.
90 # This patterns also effect to html_static_path and html_extra_path
93 # The reST default role (used for this markup: `text`) to use for all
98 # If true, '()' will be appended to :func: etc. cross-reference text.
100 # add_function_parentheses = True
102 # If true, the current module name will be prepended to all description
103 # unit titles (such as .. function::).
105 # add_module_names = True
107 # If true, sectionauthor and moduleauthor directives will be shown in the
108 # output. They are ignored by default.
110 # show_authors = False
112 # The name of the Pygments (syntax highlighting) style to use.
113 pygments_style = 'sphinx'
115 # A list of ignored prefixes for module index sorting.
116 # modindex_common_prefix = []
118 # If true, keep warnings as "system message" paragraphs in the built documents.
119 # keep_warnings = False
121 # If true, `todo` and `todoList` produce output, else they produce nothing.
122 todo_include_todos = True
125 # -- Options for HTML output ----------------------------------------------
127 # The theme to use for HTML and HTML Help pages. See the documentation for
128 # a list of builtin themes.
130 html_theme = 'alabaster'
131 html_theme = 'classic'
132 #html_theme = "sphinx_rtd_theme"
133 #html_theme = 'bootstrap'
135 # Theme options are theme-specific and customize the look and feel of a theme
136 # further. For a list of options available for each theme, see the
139 # html_theme_options = {}
141 # Add any paths that contain custom themes here, relative to this directory.
142 # html_theme_path = []
143 #html_theme_path = ['/usr/lib/python3/dist-packages/sphinx_bootstrap_theme']
145 # The name for this set of Sphinx documents.
146 # "<project> v<release> documentation" by default.
148 # html_title = u'Python ListenBrainz Module v0.0.1'
150 # A shorter title for the navigation bar. Default is the same as html_title.
152 # html_short_title = None
154 # The name of an image file (relative to this directory) to place at the top
159 # The name of an image file (relative to this directory) to use as a favicon of
160 # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
163 # html_favicon = None
165 # Add any paths that contain custom static files (such as style sheets) here,
166 # relative to this directory. They are copied after the builtin static files,
167 # so a file named "default.css" will overwrite the builtin "default.css".
168 #chtml_static_path = ['_static']
170 # Add any extra paths that contain custom files (such as robots.txt or
171 # .htaccess) here, relative to this directory. These files are copied
172 # directly to the root of the documentation.
174 # html_extra_path = []
176 # If not None, a 'Last updated on:' timestamp is inserted at every page
177 # bottom, using the given strftime format.
178 # The empty string is equivalent to '%b %d, %Y'.
180 # html_last_updated_fmt = None
182 # If true, SmartyPants will be used to convert quotes and dashes to
183 # typographically correct entities.
185 # html_use_smartypants = True
187 # Custom sidebar templates, maps document names to template names.
191 # Additional templates that should be rendered to pages, maps page names to
194 # html_additional_pages = {}
196 # If false, no module index is generated.
198 # html_domain_indices = True
200 # If false, no index is generated.
202 # html_use_index = True
204 # If true, the index is split into individual pages for each letter.
206 # html_split_index = False
208 # If true, links to the reST sources are added to the pages.
210 # html_show_sourcelink = True
212 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
214 # html_show_sphinx = True
215 html_show_sphinx = False
217 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
219 # html_show_copyright = True
221 # If true, an OpenSearch description file will be output, and all pages will
222 # contain a <link> tag referring to it. The value of this option must be the
223 # base URL from which the finished HTML is served.
225 # html_use_opensearch = ''
227 # This is the file name suffix for HTML files (e.g. ".xhtml").
228 # html_file_suffix = None
230 # Language to be used for generating the HTML full-text search index.
231 # Sphinx supports the following languages:
232 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
233 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
235 # html_search_language = 'en'
237 # A dictionary with options for the search language support, empty by default.
238 # 'ja' uses this config value.
239 # 'zh' user can custom change `jieba` dictionary path.
241 # html_search_options = {'type': 'default'}
243 # The name of a javascript file (relative to the configuration directory) that
244 # implements a search results scorer. If empty, the default will be used.
246 # html_search_scorer = 'scorer.js'
248 # Output file base name for HTML help builder.
249 htmlhelp_basename = 'PythonListenBrainzModuledoc'
251 # -- Options for LaTeX output ---------------------------------------------
254 # The paper size ('letterpaper' or 'a4paper').
256 # 'papersize': 'letterpaper',
258 # The font size ('10pt', '11pt' or '12pt').
260 # 'pointsize': '10pt',
262 # Additional stuff for the LaTeX preamble.
266 # Latex figure (float) alignment
268 # 'figure_align': 'htbp',
271 # Grouping the document tree into LaTeX files. List of tuples
272 # (source start file, target name, title,
273 # author, documentclass [howto, manual, or own class]).
275 (master_doc, 'PythonListenBrainzModule.tex', u'Python ListenBrainz Module Documentation',
276 u'kaliko', 'manual'),
279 # The name of an image file (relative to this directory) to place at the top of
284 # For "manual" documents, if this is true, then toplevel headings are parts,
287 # latex_use_parts = False
289 # If true, show page references after internal links.
291 # latex_show_pagerefs = False
293 # If true, show URL addresses after external links.
295 # latex_show_urls = False
297 # Documents to append as an appendix to all manuals.
299 # latex_appendices = []
301 # It false, will not define \strong, \code, itleref, \crossref ... but only
302 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
305 # latex_keep_old_macro_names = True
307 # If false, no module index is generated.
309 # latex_domain_indices = True
312 # -- Options for manual page output ---------------------------------------
314 # One entry per manual page. List of tuples
315 # (source start file, name, description, authors, manual section).
317 (master_doc, 'pythonlistenbrainzmodule', u'Python ListenBrainz Module Documentation',
321 # If true, show URL addresses after external links.
323 # man_show_urls = False
326 # -- Options for Texinfo output -------------------------------------------
328 # Grouping the document tree into Texinfo files. List of tuples
329 # (source start file, target name, title, author,
330 # dir menu entry, description, category)
331 texinfo_documents = [
332 (master_doc, 'PythonListenBrainzModule', u'Python ListenBrainz Module Documentation',
333 author, 'PythonListenBrainzModule', 'One line description of project.',
337 # Documents to append as an appendix to all manuals.
339 # texinfo_appendices = []
341 # If false, no module index is generated.
343 # texinfo_domain_indices = True
345 # How to display URL addresses: 'footnote', 'no', or 'inline'.
347 # texinfo_show_urls = 'footnote'
349 # If true, do not generate a @detailmenu in the "Top" node's menu.
351 # texinfo_no_detailmenu = False
354 # -- Options for Epub output ----------------------------------------------
356 # Bibliographic Dublin Core info.
359 epub_publisher = author
360 epub_copyright = copyright
362 # The basename for the epub file. It defaults to the project name.
363 # epub_basename = project
365 # The HTML theme for the epub output. Since the default themes are not
366 # optimized for small screen space, using the same theme for HTML and epub
367 # output is usually not wise. This defaults to 'epub', a theme designed to save
370 # epub_theme = 'epub'
372 # The language of the text. It defaults to the language option
373 # or 'en' if the language is not set.
377 # The scheme of the identifier. Typical schemes are ISBN or URL.
380 # The unique identifier of the text. This can be a ISBN number
381 # or the project homepage.
383 # epub_identifier = ''
385 # A unique identification for the text.
389 # A tuple containing the cover image and cover page html template filenames.
393 # A sequence of (type, uri, title) tuples for the guide element of content.opf.
397 # HTML files that should be inserted before the pages created by sphinx.
398 # The format is a list of tuples containing the path and title.
400 # epub_pre_files = []
402 # HTML files that should be inserted after the pages created by sphinx.
403 # The format is a list of tuples containing the path and title.
405 # epub_post_files = []
407 # A list of files that should not be packed into the epub file.
408 epub_exclude_files = ['search.html']
410 # The depth of the table of contents in toc.ncx.
414 # Allow duplicate toc entries.
418 # Choose between 'default' and 'includehidden'.
420 # epub_tocscope = 'default'
422 # Fix unsupported image types using the Pillow.
424 # epub_fix_images = False
426 # Scale large images.
428 # epub_max_image_width = 0
430 # How to display URL addresses: 'footnote', 'no', or 'inline'.
432 # epub_show_urls = 'inline'
434 # If false, no index is generated.
436 # epub_use_index = True
439 # Example configuration for intersphinx: refer to the Python standard library.
440 intersphinx_mapping = {'https://docs.python.org/': None}
443 autodoc_member_order = 'bysource'