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 sys.path.insert(0, os.path.abspath('../../'))
25 from sima.info import __version__, __author__
27 # -- General configuration ------------------------------------------------
29 # If your documentation needs a minimal Sphinx version, state it here.
32 # Add any Sphinx extension module names here, as strings. They can be
33 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
37 'sphinx.ext.viewcode',
38 'sphinx.ext.intersphinx',
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:
46 # source_suffix = ['.rst', '.md']
47 source_suffix = '.rst'
49 # The encoding of source files.
50 #source_encoding = 'utf-8-sig'
52 # The master toctree document.
55 # General information about the project.
57 from datetime import datetime
58 copyright = '2009-{}, {}'.format(datetime.now().year, __author__)
61 # The version info for the project you're documenting, acts as replacement for
62 # |version| and |release|, also used in various other places throughout the
65 # The short X.Y version.
67 # The full version, including alpha/beta/rc tags.
70 # The language for content autogenerated by Sphinx. Refer to documentation
71 # for a list of supported languages.
73 # This is also used if you do content translation via gettext catalogs.
74 # Usually you set "language" from the command line for these cases.
77 # There are two options for replacing |today|: either, you set today to some
78 # non-false value, then it is used:
80 # Else, today_fmt is used as the format for a strftime call.
81 #today_fmt = '%B %d, %Y'
83 # List of patterns, relative to source directory, that match files and
84 # directories to ignore when looking for source files.
87 # The reST default role (used for this markup: `text`) to use for all
91 # If true, '()' will be appended to :func: etc. cross-reference text.
92 #add_function_parentheses = True
94 # If true, the current module name will be prepended to all description
95 # unit titles (such as .. function::).
96 #add_module_names = True
98 # If true, sectionauthor and moduleauthor directives will be shown in the
99 # output. They are ignored by default.
100 #show_authors = False
102 # The name of the Pygments (syntax highlighting) style to use.
103 pygments_style = 'sphinx'
105 # A list of ignored prefixes for module index sorting.
106 #modindex_common_prefix = []
108 # If true, keep warnings as "system message" paragraphs in the built documents.
109 #keep_warnings = False
111 # If true, `todo` and `todoList` produce output, else they produce nothing.
112 todo_include_todos = False
115 # -- Options for HTML output ----------------------------------------------
117 # The theme to use for HTML and HTML Help pages. See the documentation for
118 # a list of builtin themes.
119 html_theme = 'classic'
121 # Theme options are theme-specific and customize the look and feel of a theme
122 # further. For a list of options available for each theme, see the
124 html_theme_options = {
125 "externalrefs": True,
126 "sidebarwidth": "300px",
127 "bgcolor": "#dfdfdf",
130 # Add any paths that contain custom themes here, relative to this directory.
131 #html_theme_path = []
133 # The name for this set of Sphinx documents. If None, it defaults to
134 # "<project> v<release> documentation".
137 # A shorter title for the navigation bar. Default is the same as html_title.
138 #html_short_title = None
140 # The name of an image file (relative to this directory) to place at the top
144 # The name of an image file (within the static path) to use as favicon of the
145 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
149 # Add any paths that contain custom static files (such as style sheets) here,
150 # relative to this directory. They are copied after the builtin static files,
151 # so a file named "default.css" will overwrite the builtin "default.css".
152 html_static_path = ['_static']
154 # Add any extra paths that contain custom files (such as robots.txt or
155 # .htaccess) here, relative to this directory. These files are copied
156 # directly to the root of the documentation.
157 #html_extra_path = []
159 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
160 # using the given strftime format.
161 #html_last_updated_fmt = '%b %d, %Y'
163 # If true, SmartyPants will be used to convert quotes and dashes to
164 # typographically correct entities.
165 #html_use_smartypants = True
167 # Custom sidebar templates, maps document names to template names.
170 # Additional templates that should be rendered to pages, maps page names to
172 #html_additional_pages = {}
174 # If false, no module index is generated.
175 #html_domain_indices = True
177 # If false, no index is generated.
178 #html_use_index = True
180 # If true, the index is split into individual pages for each letter.
181 #html_split_index = False
183 # If true, links to the reST sources are added to the pages.
184 #html_show_sourcelink = True
186 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
187 #html_show_sphinx = True
189 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
190 #html_show_copyright = True
192 # If true, an OpenSearch description file will be output, and all pages will
193 # contain a <link> tag referring to it. The value of this option must be the
194 # base URL from which the finished HTML is served.
195 #html_use_opensearch = ''
197 # This is the file name suffix for HTML files (e.g. ".xhtml").
198 #html_file_suffix = None
200 # Language to be used for generating the HTML full-text search index.
201 # Sphinx supports the following languages:
202 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
203 # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
204 #html_search_language = 'en'
206 # A dictionary with options for the search language support, empty by default.
207 # Now only 'ja' uses this config value
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 = 'MPD_simadoc'
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, 'MPD_sima.tex', 'MPD\\_sima Documentation',
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, 'mpd_sima', 'MPD_sima 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, 'MPD_sima', 'MPD_sima Documentation',
282 author, 'MPD_sima', '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
298 intersphinx_mapping = {'https://docs.python.org/': None}