2 # -*- coding: utf-8 -*-
4 # MPD_sima documentation build configuration file, created by
5 # sphinx-quickstart on Wed Nov 11 13:21:17 2015.
7 # This file is execfile()d with the current directory set to its
10 # Note that not all possible configuration values are present in this
13 # All configuration values have a default; values that are commented out
14 # serve to show the default.
20 # If extensions (or modules to document with autodoc) are in another directory,
21 # add these directories to sys.path here. If the directory is relative to the
22 # documentation root, use os.path.abspath to make it absolute, like shown here.
23 #sys.path.insert(0, os.path.abspath('.'))
24 from sima.info import __author__
26 # -- General configuration ------------------------------------------------
28 # If your documentation needs a minimal Sphinx version, state it here.
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.viewcode',
37 'sphinx.ext.intersphinx',
40 # Add any paths that contain templates here, relative to this directory.
41 templates_path = ['_templates']
43 # The suffix(es) of source filenames.
44 # You can specify multiple suffix as a list of string:
45 # source_suffix = ['.rst', '.md']
46 source_suffix = '.rst'
48 # The encoding of source files.
49 #source_encoding = 'utf-8-sig'
51 # The master toctree document.
54 # General information about the project.
56 from datetime import datetime
57 copyright = '2009-{}, {}'.format(datetime.now().year, __author__)
60 # The version info for the project you're documenting, acts as replacement for
61 # |version| and |release|, also used in various other places throughout the
64 # The short X.Y version.
66 # The full version, including alpha/beta/rc tags.
69 # The language for content autogenerated by Sphinx. Refer to documentation
70 # for a list of supported languages.
72 # This is also used if you do content translation via gettext catalogs.
73 # Usually you set "language" from the command line for these cases.
76 # There are two options for replacing |today|: either, you set today to some
77 # non-false value, then it is used:
79 # Else, today_fmt is used as the format for a strftime call.
80 #today_fmt = '%B %d, %Y'
82 # List of patterns, relative to source directory, that match files and
83 # directories to ignore when looking for source files.
86 # The reST default role (used for this markup: `text`) to use for all
90 # If true, '()' will be appended to :func: etc. cross-reference text.
91 #add_function_parentheses = True
93 # If true, the current module name will be prepended to all description
94 # unit titles (such as .. function::).
95 #add_module_names = True
97 # If true, sectionauthor and moduleauthor directives will be shown in the
98 # output. They are ignored by default.
101 # The name of the Pygments (syntax highlighting) style to use.
102 pygments_style = 'sphinx'
104 # A list of ignored prefixes for module index sorting.
105 #modindex_common_prefix = []
107 # If true, keep warnings as "system message" paragraphs in the built documents.
108 #keep_warnings = False
110 # If true, `todo` and `todoList` produce output, else they produce nothing.
111 todo_include_todos = False
114 # -- Options for HTML output ----------------------------------------------
116 # The theme to use for HTML and HTML Help pages. See the documentation for
117 # a list of builtin themes.
118 html_theme = 'classic'
120 # Theme options are theme-specific and customize the look and feel of a theme
121 # further. For a list of options available for each theme, see the
123 html_theme_options = {
124 "externalrefs": True,
125 "sidebarwidth": "300px",
126 "bgcolor": "#dfdfdf",
129 # Add any paths that contain custom themes here, relative to this directory.
130 #html_theme_path = []
132 # The name for this set of Sphinx documents. If None, it defaults to
133 # "<project> v<release> documentation".
136 # A shorter title for the navigation bar. Default is the same as html_title.
137 #html_short_title = None
139 # The name of an image file (relative to this directory) to place at the top
143 # The name of an image file (within the static path) to use as favicon of the
144 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
148 # Add any paths that contain custom static files (such as style sheets) here,
149 # relative to this directory. They are copied after the builtin static files,
150 # so a file named "default.css" will overwrite the builtin "default.css".
151 html_static_path = ['_static']
153 # Add any extra paths that contain custom files (such as robots.txt or
154 # .htaccess) here, relative to this directory. These files are copied
155 # directly to the root of the documentation.
156 #html_extra_path = []
158 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
159 # using the given strftime format.
160 #html_last_updated_fmt = '%b %d, %Y'
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', 'h', 'it', 'ja'
202 # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
203 #html_search_language = 'en'
205 # A dictionary with options for the search language support, empty by default.
206 # Now only 'ja' uses this config value
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 = 'MPD_simadoc'
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, 'MPD_sima.tex', 'MPD\\_sima Documentation',
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 ('man/mpd-sima.1', 'mpd-sima',
267 'mpd-sima will try to maintain some titles ahead in the queue following different policies.',
269 ('man/mpd_sima.cfg.5', 'mpd_sima.cfg',
270 'mpd-sima configuration.',
274 # If true, show URL addresses after external links.
275 #man_show_urls = False
278 # -- Options for Texinfo output -------------------------------------------
280 # Grouping the document tree into Texinfo files. List of tuples
281 # (source start file, target name, title, author,
282 # dir menu entry, description, category)
283 texinfo_documents = [
284 (master_doc, 'MPD_sima', 'MPD_sima Documentation',
285 author, 'MPD_sima', 'One line description of project.',
289 # Documents to append as an appendix to all manuals.
290 #texinfo_appendices = []
292 # If false, no module index is generated.
293 #texinfo_domain_indices = True
295 # How to display URL addresses: 'footnote', 'no', or 'inline'.
296 #texinfo_show_urls = 'footnote'
298 # If true, do not generate a @detailmenu in the "Top" node's menu.
299 #texinfo_no_detailmenu = False
301 intersphinx_mapping = {'https://docs.python.org/': None}