1 # -*- coding: utf-8 -*-
3 # sqlconvert documentation build configuration file, created by
4 # sphinx-quickstart on Fri Jul 22 19:32:24 2016.
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.
19 from datetime import date
22 sys.path.insert(0, os.path.abspath('..'))
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.viewcode',
38 # Add any paths that contain templates here, relative to this directory.
39 templates_path = ['_templates']
41 # The suffix(es) of source filenames.
42 # You can specify multiple suffix as a list of string:
44 # source_suffix = ['.rst', '.md']
45 source_suffix = '.rst'
47 # The encoding of source files.
49 # source_encoding = 'utf-8-sig'
51 # The master toctree document.
54 # General information about the project.
55 project = u'sqlconvert'
56 author = u'Oleg Broytman'
57 copyright = u'2016-%d, %s' % (date.today().year, author)
59 # The version info for the project you're documenting, acts as replacement for
60 # |version| and |release|, also used in various other places throughout the
63 # The short X.Y version.
64 from sqlconvert.__version__ import __version__
65 # The short X.Y version.
66 version = '.'.join(__version__.split('.')[:2])
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:
82 # Else, today_fmt is used as the format for a strftime call.
84 # today_fmt = '%B %d, %Y'
86 # List of patterns, relative to source directory, that match files and
87 # directories to ignore when looking for source files.
88 # This patterns also effect to html_static_path and html_extra_path
89 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
91 # The reST default role (used for this markup: `text`) to use for all
96 # If true, '()' will be appended to :func: etc. cross-reference text.
98 # add_function_parentheses = True
100 # If true, the current module name will be prepended to all description
101 # unit titles (such as .. function::).
103 # add_module_names = True
105 # If true, sectionauthor and moduleauthor directives will be shown in the
106 # output. They are ignored by default.
108 # show_authors = False
110 # The name of the Pygments (syntax highlighting) style to use.
111 pygments_style = 'sphinx'
113 # A list of ignored prefixes for module index sorting.
114 # modindex_common_prefix = []
116 # If true, keep warnings as "system message" paragraphs in the built documents.
117 # keep_warnings = False
119 # If true, `todo` and `todoList` produce output, else they produce nothing.
120 todo_include_todos = False
123 # -- Options for HTML output ----------------------------------------------
125 # The theme to use for HTML and HTML Help pages. See the documentation for
126 # a list of builtin themes.
128 html_theme = 'alabaster'
130 # Theme options are theme-specific and customize the look and feel of a theme
131 # further. For a list of options available for each theme, see the
134 # html_theme_options = {}
136 # Add any paths that contain custom themes here, relative to this directory.
137 # html_theme_path = []
139 # The name for this set of Sphinx documents.
140 # "<project> v<release> documentation" by default.
142 # html_title = u'sqlconvert v0.0.1'
144 # A shorter title for the navigation bar. Default is the same as html_title.
146 # html_short_title = None
148 # The name of an image file (relative to this directory) to place at the top
153 # The name of an image file (relative to this directory) to use as a favicon of
154 # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
157 # html_favicon = None
159 # Add any paths that contain custom static files (such as style sheets) here,
160 # relative to this directory. They are copied after the builtin static files,
161 # so a file named "default.css" will overwrite the builtin "default.css".
162 html_static_path = ['_static']
164 # Add any extra paths that contain custom files (such as robots.txt or
165 # .htaccess) here, relative to this directory. These files are copied
166 # directly to the root of the documentation.
168 # html_extra_path = []
170 # If not None, a 'Last updated on:' timestamp is inserted at every page
171 # bottom, using the given strftime format.
172 # The empty string is equivalent to '%b %d, %Y'.
174 # html_last_updated_fmt = None
176 # If true, SmartyPants will be used to convert quotes and dashes to
177 # typographically correct entities.
179 # html_use_smartypants = True
181 # Custom sidebar templates, maps document names to template names.
185 # Additional templates that should be rendered to pages, maps page names to
188 # html_additional_pages = {}
190 # If false, no module index is generated.
192 # html_domain_indices = True
194 # If false, no index is generated.
196 # html_use_index = True
198 # If true, the index is split into individual pages for each letter.
200 # html_split_index = False
202 # If true, links to the reST sources are added to the pages.
204 # html_show_sourcelink = True
206 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
208 # html_show_sphinx = True
210 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
212 # html_show_copyright = True
214 # If true, an OpenSearch description file will be output, and all pages will
215 # contain a <link> tag referring to it. The value of this option must be the
216 # base URL from which the finished HTML is served.
218 # html_use_opensearch = ''
220 # This is the file name suffix for HTML files (e.g. ".xhtml").
221 # html_file_suffix = None
223 # Language to be used for generating the HTML full-text search index.
224 # Sphinx supports the following languages:
225 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
226 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
228 # html_search_language = 'en'
230 # A dictionary with options for the search language support, empty by default.
231 # 'ja' uses this config value.
232 # 'zh' user can custom change `jieba` dictionary path.
234 # html_search_options = {'type': 'default'}
236 # The name of a javascript file (relative to the configuration directory) that
237 # implements a search results scorer. If empty, the default will be used.
239 # html_search_scorer = 'scorer.js'
241 # Output file base name for HTML help builder.
242 htmlhelp_basename = 'sqlconvert_doc'
244 # -- Options for LaTeX output ---------------------------------------------
247 # The paper size ('letterpaper' or 'a4paper').
249 # 'papersize': 'letterpaper',
251 # The font size ('10pt', '11pt' or '12pt').
253 # 'pointsize': '10pt',
255 # Additional stuff for the LaTeX preamble.
259 # Latex figure (float) alignment
261 # 'figure_align': 'htbp',
264 # Grouping the document tree into LaTeX files. List of tuples
265 # (source start file, target name, title,
266 # author, documentclass [howto, manual, or own class]).
268 (master_doc, 'sqlconvert.tex', u'sqlconvert Documentation',
269 u'Oleg Broytman', 'manual'),
272 # The name of an image file (relative to this directory) to place at the top of
277 # For "manual" documents, if this is true, then toplevel headings are parts,
280 # latex_use_parts = False
282 # If true, show page references after internal links.
284 # latex_show_pagerefs = False
286 # If true, show URL addresses after external links.
288 # latex_show_urls = False
290 # Documents to append as an appendix to all manuals.
292 # latex_appendices = []
294 # It false, will not define \strong, \code, itleref, \crossref ... but only
295 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
298 # latex_keep_old_macro_names = True
300 # If false, no module index is generated.
302 # latex_domain_indices = True
305 # -- Options for manual page output ---------------------------------------
307 # One entry per manual page. List of tuples
308 # (source start file, name, description, authors, manual section).
310 (master_doc, 'sqlconvert', u'sqlconvert Documentation',
314 # If true, show URL addresses after external links.
316 # man_show_urls = False
319 # -- Options for Texinfo output -------------------------------------------
321 # Grouping the document tree into Texinfo files. List of tuples
322 # (source start file, target name, title, author,
323 # dir menu entry, description, category)
324 texinfo_documents = [
325 (master_doc, 'sqlconvert', u'sqlconvert Documentation',
326 author, 'sqlconvert', 'One line description of project.',
330 # Documents to append as an appendix to all manuals.
332 # texinfo_appendices = []
334 # If false, no module index is generated.
336 # texinfo_domain_indices = True
338 # How to display URL addresses: 'footnote', 'no', or 'inline'.
340 # texinfo_show_urls = 'footnote'
342 # If true, do not generate a @detailmenu in the "Top" node's menu.
344 # texinfo_no_detailmenu = False