]> kaliko git repositories - python-musicpd.git/blob - doc/source/conf.py
71de7639ed6d388a6a84a44deccfd29e46058d33
[python-musicpd.git] / doc / source / conf.py
1 # coding: utf-8
2 # SPDX-FileCopyrightText: 2018-2021  kaliko <kaliko@azylum.org>
3 # SPDX-License-Identifier: LGPL-3.0-or-later
4 #
5 # Python MPD Module documentation build configuration file, created by
6 # sphinx-quickstart on Mon Mar 12 14:37:32 2018.
7 #
8 # This file is execfile()d with the current directory set to its
9 # containing dir.
10 #
11 # Note that not all possible configuration values are present in this
12 # autogenerated file.
13 #
14 # All configuration values have a default; values that are commented out
15 # serve to show the default.
16
17 # If extensions (or modules to document with autodoc) are in another directory,
18 # add these directories to sys.path here. If the directory is relative to the
19 # documentation root, use os.path.abspath to make it absolute, like shown here.
20 #
21 import os
22 import sys
23 sys.path.insert(0, os.path.abspath('../../'))
24 from musicpd import VERSION
25 __author__ = 'kaliko'
26 # -- General configuration ------------------------------------------------
27
28 # If your documentation needs a minimal Sphinx version, state it here.
29 #
30 # needs_sphinx = '1.0'
31
32 # Add any Sphinx extension module names here, as strings. They can be
33 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
34 # ones.
35 extensions = [
36     'sphinx.ext.autodoc',
37     'sphinx.ext.intersphinx',
38     #'sphinx.ext.coverage',
39     'sphinx.ext.viewcode',
40     'sphinx.ext.todo',
41 ]
42
43 # Add any paths that contain templates here, relative to this directory.
44 templates_path = ['_templates']
45
46 # The suffix(es) of source filenames.
47 # You can specify multiple suffix as a list of string:
48 #
49 # source_suffix = ['.rst', '.md']
50 source_suffix = '.rst'
51
52 # The encoding of source files.
53 #
54 # source_encoding = 'utf-8-sig'
55
56 # The master toctree document.
57 master_doc = 'index'
58
59 # General information about the project.
60 project = u'Python MPD Module'
61 from datetime import datetime
62 copyright = u'2012-{}, {}'.format(datetime.now().year, __author__)
63 author = __author__
64
65 # The version info for the project you're documenting, acts as replacement for
66 # |version| and |release|, also used in various other places throughout the
67 # built documents.
68 #
69 # The short X.Y version.
70 version = VERSION
71 # The full version, including alpha/beta/rc tags.
72 release = VERSION
73
74 # The language for content autogenerated by Sphinx. Refer to documentation
75 # for a list of supported languages.
76 #
77 # This is also used if you do content translation via gettext catalogs.
78 # Usually you set "language" from the command line for these cases.
79 #language = None
80
81 # There are two options for replacing |today|: either, you set today to some
82 # non-false value, then it is used:
83 #
84 # today = ''
85 #
86 # Else, today_fmt is used as the format for a strftime call.
87 #
88 # today_fmt = '%B %d, %Y'
89
90 # List of patterns, relative to source directory, that match files and
91 # directories to ignore when looking for source files.
92 # This patterns also effect to html_static_path and html_extra_path
93 exclude_patterns = []
94
95 # The reST default role (used for this markup: `text`) to use for all
96 # documents.
97 #
98 # default_role = None
99
100 # If true, '()' will be appended to :func: etc. cross-reference text.
101 #
102 # add_function_parentheses = True
103
104 # If true, the current module name will be prepended to all description
105 # unit titles (such as .. function::).
106 #
107 # add_module_names = True
108
109 # If true, sectionauthor and moduleauthor directives will be shown in the
110 # output. They are ignored by default.
111 #
112 # show_authors = False
113
114 # The name of the Pygments (syntax highlighting) style to use.
115 pygments_style = 'sphinx'
116
117 # A list of ignored prefixes for module index sorting.
118 # modindex_common_prefix = []
119
120 # If true, keep warnings as "system message" paragraphs in the built documents.
121 # keep_warnings = False
122
123 # If true, `todo` and `todoList` produce output, else they produce nothing.
124 todo_include_todos = True
125
126
127 # -- Options for HTML output ----------------------------------------------
128
129 # The theme to use for HTML and HTML Help pages.  See the documentation for
130 # a list of builtin themes.
131 #
132 html_theme = 'classic'
133 #html_theme = "sphinx_rtd_theme"
134 #html_theme = 'bootstrap'
135
136 # Theme options are theme-specific and customize the look and feel of a theme
137 # further.  For a list of options available for each theme, see the
138 # documentation.
139 #
140 # html_theme_options = {}
141
142 # Add any paths that contain custom themes here, relative to this directory.
143 # html_theme_path = []
144 #html_theme_path = ['/usr/lib/python3/dist-packages/sphinx_bootstrap_theme']
145
146 # The name for this set of Sphinx documents.
147 # "<project> v<release> documentation" by default.
148 #
149 # html_title = u'Python MPD Module v0.0.1'
150
151 # A shorter title for the navigation bar.  Default is the same as html_title.
152 #
153 # html_short_title = None
154
155 # The name of an image file (relative to this directory) to place at the top
156 # of the sidebar.
157 #
158 # html_logo = None
159
160 # The name of an image file (relative to this directory) to use as a favicon of
161 # the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
162 # pixels large.
163 #
164 # html_favicon = None
165
166 # Add any paths that contain custom static files (such as style sheets) here,
167 # relative to this directory. They are copied after the builtin static files,
168 # so a file named "default.css" will overwrite the builtin "default.css".
169 #chtml_static_path = ['_static']
170
171 # Add any extra paths that contain custom files (such as robots.txt or
172 # .htaccess) here, relative to this directory. These files are copied
173 # directly to the root of the documentation.
174 #
175 # html_extra_path = []
176
177 # If not None, a 'Last updated on:' timestamp is inserted at every page
178 # bottom, using the given strftime format.
179 # The empty string is equivalent to '%b %d, %Y'.
180 #
181 # html_last_updated_fmt = None
182
183 # If true, SmartyPants will be used to convert quotes and dashes to
184 # typographically correct entities.
185 #
186 # html_use_smartypants = True
187
188 # Custom sidebar templates, maps document names to template names.
189 #
190 # html_sidebars = {}
191
192 # Additional templates that should be rendered to pages, maps page names to
193 # template names.
194 #
195 # html_additional_pages = {}
196
197 # If false, no module index is generated.
198 #
199 # html_domain_indices = True
200
201 # If false, no index is generated.
202 #
203 # html_use_index = True
204
205 # If true, the index is split into individual pages for each letter.
206 #
207 # html_split_index = False
208
209 # If true, links to the reST sources are added to the pages.
210 #
211 # html_show_sourcelink = True
212
213 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
214 #
215 # html_show_sphinx = True
216 html_show_sphinx = False
217
218 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
219 #
220 # html_show_copyright = True
221
222 # If true, an OpenSearch description file will be output, and all pages will
223 # contain a <link> tag referring to it.  The value of this option must be the
224 # base URL from which the finished HTML is served.
225 #
226 # html_use_opensearch = ''
227
228 # This is the file name suffix for HTML files (e.g. ".xhtml").
229 # html_file_suffix = None
230
231 # Language to be used for generating the HTML full-text search index.
232 # Sphinx supports the following languages:
233 #   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
234 #   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
235 #
236 # html_search_language = 'en'
237
238 # A dictionary with options for the search language support, empty by default.
239 # 'ja' uses this config value.
240 # 'zh' user can custom change `jieba` dictionary path.
241 #
242 # html_search_options = {'type': 'default'}
243
244 # The name of a javascript file (relative to the configuration directory) that
245 # implements a search results scorer. If empty, the default will be used.
246 #
247 # html_search_scorer = 'scorer.js'
248
249 # Output file base name for HTML help builder.
250 htmlhelp_basename = 'PythonMPDModuledoc'
251
252 # -- Options for LaTeX output ---------------------------------------------
253
254 latex_elements = {
255      # The paper size ('letterpaper' or 'a4paper').
256      #
257      # 'papersize': 'letterpaper',
258
259      # The font size ('10pt', '11pt' or '12pt').
260      #
261      # 'pointsize': '10pt',
262
263      # Additional stuff for the LaTeX preamble.
264      #
265      # 'preamble': '',
266
267      # Latex figure (float) alignment
268      #
269      # 'figure_align': 'htbp',
270 }
271
272 # Grouping the document tree into LaTeX files. List of tuples
273 # (source start file, target name, title,
274 #  author, documentclass [howto, manual, or own class]).
275 latex_documents = [
276     (master_doc, 'PythonMPDModule.tex', u'Python MPD Module Documentation',
277      u'kaliko', 'manual'),
278 ]
279
280 # The name of an image file (relative to this directory) to place at the top of
281 # the title page.
282 #
283 # latex_logo = None
284
285 # For "manual" documents, if this is true, then toplevel headings are parts,
286 # not chapters.
287 #
288 # latex_use_parts = False
289
290 # If true, show page references after internal links.
291 #
292 # latex_show_pagerefs = False
293
294 # If true, show URL addresses after external links.
295 #
296 # latex_show_urls = False
297
298 # Documents to append as an appendix to all manuals.
299 #
300 # latex_appendices = []
301
302 # It false, will not define \strong, \code,     itleref, \crossref ... but only
303 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
304 # packages.
305 #
306 # latex_keep_old_macro_names = True
307
308 # If false, no module index is generated.
309 #
310 # latex_domain_indices = True
311
312
313 # -- Options for manual page output ---------------------------------------
314
315 # One entry per manual page. List of tuples
316 # (source start file, name, description, authors, manual section).
317 man_pages = [
318     (master_doc, 'pythonmpdmodule', u'Python MPD Module Documentation',
319      [author], 1)
320 ]
321
322 # If true, show URL addresses after external links.
323 #
324 # man_show_urls = False
325
326
327 # -- Options for Texinfo output -------------------------------------------
328
329 # Grouping the document tree into Texinfo files. List of tuples
330 # (source start file, target name, title, author,
331 #  dir menu entry, description, category)
332 texinfo_documents = [
333     (master_doc, 'PythonMPDModule', u'Python MPD Module Documentation',
334      author, 'PythonMPDModule', 'One line description of project.',
335      'Miscellaneous'),
336 ]
337
338 # Documents to append as an appendix to all manuals.
339 #
340 # texinfo_appendices = []
341
342 # If false, no module index is generated.
343 #
344 # texinfo_domain_indices = True
345
346 # How to display URL addresses: 'footnote', 'no', or 'inline'.
347 #
348 # texinfo_show_urls = 'footnote'
349
350 # If true, do not generate a @detailmenu in the "Top" node's menu.
351 #
352 # texinfo_no_detailmenu = False
353
354
355 # -- Options for Epub output ----------------------------------------------
356
357 # Bibliographic Dublin Core info.
358 epub_title = project
359 epub_author = author
360 epub_publisher = author
361 epub_copyright = copyright
362
363 # The basename for the epub file. It defaults to the project name.
364 # epub_basename = project
365
366 # The HTML theme for the epub output. Since the default themes are not
367 # optimized for small screen space, using the same theme for HTML and epub
368 # output is usually not wise. This defaults to 'epub', a theme designed to save
369 # visual space.
370 #
371 # epub_theme = 'epub'
372
373 # The language of the text. It defaults to the language option
374 # or 'en' if the language is not set.
375 #
376 # epub_language = ''
377
378 # The scheme of the identifier. Typical schemes are ISBN or URL.
379 # epub_scheme = ''
380
381 # The unique identifier of the text. This can be a ISBN number
382 # or the project homepage.
383 #
384 # epub_identifier = ''
385
386 # A unique identification for the text.
387 #
388 # epub_uid = ''
389
390 # A tuple containing the cover image and cover page html template filenames.
391 #
392 # epub_cover = ()
393
394 # A sequence of (type, uri, title) tuples for the guide element of content.opf.
395 #
396 # epub_guide = ()
397
398 # HTML files that should be inserted before the pages created by sphinx.
399 # The format is a list of tuples containing the path and title.
400 #
401 # epub_pre_files = []
402
403 # HTML files that should be inserted after the pages created by sphinx.
404 # The format is a list of tuples containing the path and title.
405 #
406 # epub_post_files = []
407
408 # A list of files that should not be packed into the epub file.
409 epub_exclude_files = ['search.html']
410
411 # The depth of the table of contents in toc.ncx.
412 #
413 # epub_tocdepth = 3
414
415 # Allow duplicate toc entries.
416 #
417 # epub_tocdup = True
418
419 # Choose between 'default' and 'includehidden'.
420 #
421 # epub_tocscope = 'default'
422
423 # Fix unsupported image types using the Pillow.
424 #
425 # epub_fix_images = False
426
427 # Scale large images.
428 #
429 # epub_max_image_width = 0
430
431 # How to display URL addresses: 'footnote', 'no', or 'inline'.
432 #
433 # epub_show_urls = 'inline'
434
435 # If false, no index is generated.
436 #
437 # epub_use_index = True
438
439
440 # Example configuration for intersphinx: refer to the Python standard library.
441 intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
442
443 # autodoc config
444 autodoc_member_order = 'bysource'