|
313
|
1 # -*- coding: utf-8 -*-
|
|
|
2 #
|
|
316
|
3 # SQLPython documentation build configuration file, created by
|
|
|
4 # sphinx-quickstart on Wed Mar 4 15:43:28 2009.
|
|
313
|
5 #
|
|
|
6 # This file is execfile()d with the current directory set to its containing dir.
|
|
|
7 #
|
|
316
|
8 # The contents of this file are pickled, so don't put values in the namespace
|
|
|
9 # that aren't pickleable (module imports are okay, they're removed automatically).
|
|
|
10 #
|
|
313
|
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 import sys, os
|
|
|
18
|
|
316
|
19 # If your extensions are in another directory, add it here. If the directory
|
|
|
20 # is relative to the documentation root, use os.path.abspath to make it
|
|
|
21 # absolute, like shown here.
|
|
313
|
22 #sys.path.append(os.path.abspath('.'))
|
|
|
23
|
|
316
|
24 # General configuration
|
|
|
25 # ---------------------
|
|
313
|
26
|
|
|
27 # Add any Sphinx extension module names here, as strings. They can be extensions
|
|
|
28 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
|
316
|
29 extensions = ['sphinx.ext.autodoc']
|
|
313
|
30
|
|
|
31 # Add any paths that contain templates here, relative to this directory.
|
|
316
|
32 templates_path = ['.templates']
|
|
313
|
33
|
|
|
34 # The suffix of source filenames.
|
|
|
35 source_suffix = '.rst'
|
|
|
36
|
|
|
37 # The encoding of source files.
|
|
|
38 #source_encoding = 'utf-8'
|
|
|
39
|
|
|
40 # The master toctree document.
|
|
|
41 master_doc = 'index'
|
|
|
42
|
|
|
43 # General information about the project.
|
|
316
|
44 project = u'SQLPython'
|
|
313
|
45 copyright = u'2009, Catherine Devlin'
|
|
|
46
|
|
|
47 # The version info for the project you're documenting, acts as replacement for
|
|
|
48 # |version| and |release|, also used in various other places throughout the
|
|
|
49 # built documents.
|
|
|
50 #
|
|
|
51 # The short X.Y version.
|
|
|
52 version = '1.6'
|
|
|
53 # The full version, including alpha/beta/rc tags.
|
|
316
|
54 release = '1.6.1'
|
|
313
|
55
|
|
|
56 # The language for content autogenerated by Sphinx. Refer to documentation
|
|
|
57 # for a list of supported languages.
|
|
|
58 #language = None
|
|
|
59
|
|
|
60 # There are two options for replacing |today|: either, you set today to some
|
|
|
61 # non-false value, then it is used:
|
|
|
62 #today = ''
|
|
|
63 # Else, today_fmt is used as the format for a strftime call.
|
|
|
64 #today_fmt = '%B %d, %Y'
|
|
|
65
|
|
|
66 # List of documents that shouldn't be included in the build.
|
|
|
67 #unused_docs = []
|
|
|
68
|
|
|
69 # List of directories, relative to source directory, that shouldn't be searched
|
|
|
70 # for source files.
|
|
|
71 exclude_trees = []
|
|
|
72
|
|
|
73 # The reST default role (used for this markup: `text`) to use for all documents.
|
|
|
74 #default_role = None
|
|
|
75
|
|
|
76 # If true, '()' will be appended to :func: etc. cross-reference text.
|
|
|
77 #add_function_parentheses = True
|
|
|
78
|
|
|
79 # If true, the current module name will be prepended to all description
|
|
|
80 # unit titles (such as .. function::).
|
|
|
81 #add_module_names = True
|
|
|
82
|
|
|
83 # If true, sectionauthor and moduleauthor directives will be shown in the
|
|
|
84 # output. They are ignored by default.
|
|
|
85 #show_authors = False
|
|
|
86
|
|
|
87 # The name of the Pygments (syntax highlighting) style to use.
|
|
|
88 pygments_style = 'sphinx'
|
|
|
89
|
|
|
90
|
|
316
|
91 # Options for HTML output
|
|
|
92 # -----------------------
|
|
313
|
93
|
|
316
|
94 # The style sheet to use for HTML and HTML Help pages. A file of that name
|
|
|
95 # must exist either in Sphinx' static/ path, or in one of the custom paths
|
|
|
96 # given in html_static_path.
|
|
|
97 html_style = 'default.css'
|
|
313
|
98
|
|
|
99 # The name for this set of Sphinx documents. If None, it defaults to
|
|
|
100 # "<project> v<release> documentation".
|
|
|
101 #html_title = None
|
|
|
102
|
|
|
103 # A shorter title for the navigation bar. Default is the same as html_title.
|
|
|
104 #html_short_title = None
|
|
|
105
|
|
|
106 # The name of an image file (relative to this directory) to place at the top
|
|
|
107 # of the sidebar.
|
|
|
108 #html_logo = None
|
|
|
109
|
|
|
110 # The name of an image file (within the static path) to use as favicon of the
|
|
|
111 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
|
|
112 # pixels large.
|
|
|
113 #html_favicon = None
|
|
|
114
|
|
|
115 # Add any paths that contain custom static files (such as style sheets) here,
|
|
|
116 # relative to this directory. They are copied after the builtin static files,
|
|
|
117 # so a file named "default.css" will overwrite the builtin "default.css".
|
|
316
|
118 html_static_path = ['.static']
|
|
313
|
119
|
|
|
120 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
|
|
121 # using the given strftime format.
|
|
|
122 #html_last_updated_fmt = '%b %d, %Y'
|
|
|
123
|
|
|
124 # If true, SmartyPants will be used to convert quotes and dashes to
|
|
|
125 # typographically correct entities.
|
|
|
126 #html_use_smartypants = True
|
|
|
127
|
|
|
128 # Custom sidebar templates, maps document names to template names.
|
|
|
129 #html_sidebars = {}
|
|
|
130
|
|
|
131 # Additional templates that should be rendered to pages, maps page names to
|
|
|
132 # template names.
|
|
|
133 #html_additional_pages = {}
|
|
|
134
|
|
|
135 # If false, no module index is generated.
|
|
|
136 #html_use_modindex = True
|
|
|
137
|
|
|
138 # If false, no index is generated.
|
|
|
139 #html_use_index = True
|
|
|
140
|
|
|
141 # If true, the index is split into individual pages for each letter.
|
|
|
142 #html_split_index = False
|
|
|
143
|
|
316
|
144 # If true, the reST sources are included in the HTML build as _sources/<name>.
|
|
|
145 #html_copy_source = True
|
|
313
|
146
|
|
|
147 # If true, an OpenSearch description file will be output, and all pages will
|
|
|
148 # contain a <link> tag referring to it. The value of this option must be the
|
|
|
149 # base URL from which the finished HTML is served.
|
|
|
150 #html_use_opensearch = ''
|
|
|
151
|
|
|
152 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
|
|
|
153 #html_file_suffix = ''
|
|
|
154
|
|
|
155 # Output file base name for HTML help builder.
|
|
316
|
156 htmlhelp_basename = 'SQLPythondoc'
|
|
313
|
157
|
|
|
158
|
|
316
|
159 # Options for LaTeX output
|
|
|
160 # ------------------------
|
|
313
|
161
|
|
|
162 # The paper size ('letter' or 'a4').
|
|
|
163 #latex_paper_size = 'letter'
|
|
|
164
|
|
|
165 # The font size ('10pt', '11pt' or '12pt').
|
|
|
166 #latex_font_size = '10pt'
|
|
|
167
|
|
|
168 # Grouping the document tree into LaTeX files. List of tuples
|
|
316
|
169 # (source start file, target name, title, author, document class [howto/manual]).
|
|
313
|
170 latex_documents = [
|
|
316
|
171 ('index', 'SQLPython.tex', ur'SQLPython Documentation',
|
|
|
172 ur'Catherine Devlin', 'manual'),
|
|
313
|
173 ]
|
|
|
174
|
|
|
175 # The name of an image file (relative to this directory) to place at the top of
|
|
|
176 # the title page.
|
|
|
177 #latex_logo = None
|
|
|
178
|
|
|
179 # For "manual" documents, if this is true, then toplevel headings are parts,
|
|
|
180 # not chapters.
|
|
|
181 #latex_use_parts = False
|
|
|
182
|
|
|
183 # Additional stuff for the LaTeX preamble.
|
|
|
184 #latex_preamble = ''
|
|
|
185
|
|
|
186 # Documents to append as an appendix to all manuals.
|
|
|
187 #latex_appendices = []
|
|
|
188
|
|
|
189 # If false, no module index is generated.
|
|
|
190 #latex_use_modindex = True
|
