comparison docs/source/conf.py @ 316:ea0b0e1ab6da

using original conf.py
author catherine@dellzilla
date Tue, 31 Mar 2009 09:21:09 -0400
parents 22fc9a350eaa
children
comparison
equal deleted inserted replaced
315:a0a36232983a 316:ea0b0e1ab6da
1 # -*- coding: utf-8 -*- 1 # -*- coding: utf-8 -*-
2 # 2 #
3 # sqlpython documentation build configuration file, created by 3 # SQLPython documentation build configuration file, created by
4 # sphinx-quickstart on Sat Mar 28 11:49:41 2009. 4 # sphinx-quickstart on Wed Mar 4 15:43:28 2009.
5 # 5 #
6 # This file is execfile()d with the current directory set to its containing dir. 6 # This file is execfile()d with the current directory set to its containing dir.
7 #
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).
7 # 10 #
8 # Note that not all possible configuration values are present in this 11 # Note that not all possible configuration values are present in this
9 # autogenerated file. 12 # autogenerated file.
10 # 13 #
11 # All configuration values have a default; values that are commented out 14 # All configuration values have a default; values that are commented out
12 # serve to show the default. 15 # serve to show the default.
13 16
14 import sys, os 17 import sys, os
15 18
16 # If extensions (or modules to document with autodoc) are in another directory, 19 # If your extensions are in another directory, add it here. If the directory
17 # add these directories to sys.path here. If the directory is relative to the 20 # is relative to the documentation root, use os.path.abspath to make it
18 # documentation root, use os.path.abspath to make it absolute, like shown here. 21 # absolute, like shown here.
19 #sys.path.append(os.path.abspath('.')) 22 #sys.path.append(os.path.abspath('.'))
20 23
21 # -- General configuration ----------------------------------------------------- 24 # General configuration
25 # ---------------------
22 26
23 # Add any Sphinx extension module names here, as strings. They can be extensions 27 # Add any Sphinx extension module names here, as strings. They can be extensions
24 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 28 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
25 extensions = [] 29 extensions = ['sphinx.ext.autodoc']
26 30
27 # Add any paths that contain templates here, relative to this directory. 31 # Add any paths that contain templates here, relative to this directory.
28 templates_path = ['_templates'] 32 templates_path = ['.templates']
29 33
30 # The suffix of source filenames. 34 # The suffix of source filenames.
31 source_suffix = '.rst' 35 source_suffix = '.rst'
32 36
33 # The encoding of source files. 37 # The encoding of source files.
35 39
36 # The master toctree document. 40 # The master toctree document.
37 master_doc = 'index' 41 master_doc = 'index'
38 42
39 # General information about the project. 43 # General information about the project.
40 project = u'sqlpython' 44 project = u'SQLPython'
41 copyright = u'2009, Catherine Devlin' 45 copyright = u'2009, Catherine Devlin'
42 46
43 # The version info for the project you're documenting, acts as replacement for 47 # The version info for the project you're documenting, acts as replacement for
44 # |version| and |release|, also used in various other places throughout the 48 # |version| and |release|, also used in various other places throughout the
45 # built documents. 49 # built documents.
46 # 50 #
47 # The short X.Y version. 51 # The short X.Y version.
48 version = '1.6' 52 version = '1.6'
49 # The full version, including alpha/beta/rc tags. 53 # The full version, including alpha/beta/rc tags.
50 release = '1.6.2' 54 release = '1.6.1'
51 55
52 # The language for content autogenerated by Sphinx. Refer to documentation 56 # The language for content autogenerated by Sphinx. Refer to documentation
53 # for a list of supported languages. 57 # for a list of supported languages.
54 #language = None 58 #language = None
55 59
81 #show_authors = False 85 #show_authors = False
82 86
83 # The name of the Pygments (syntax highlighting) style to use. 87 # The name of the Pygments (syntax highlighting) style to use.
84 pygments_style = 'sphinx' 88 pygments_style = 'sphinx'
85 89
86 # A list of ignored prefixes for module index sorting.
87 #modindex_common_prefix = []
88 90
91 # Options for HTML output
92 # -----------------------
89 93
90 # -- Options for HTML output --------------------------------------------------- 94 # The style sheet to use for HTML and HTML Help pages. A file of that name
91 95 # must exist either in Sphinx' static/ path, or in one of the custom paths
92 # The theme to use for HTML and HTML Help pages. Major themes that come with 96 # given in html_static_path.
93 # Sphinx are currently 'default' and 'sphinxdoc'. 97 html_style = 'default.css'
94 html_theme = 'default'
95
96 # Theme options are theme-specific and customize the look and feel of a theme
97 # further. For a list of options available for each theme, see the
98 # documentation.
99 #html_theme_options = {}
100
101 # Add any paths that contain custom themes here, relative to this directory.
102 #html_theme_path = []
103 98
104 # The name for this set of Sphinx documents. If None, it defaults to 99 # The name for this set of Sphinx documents. If None, it defaults to
105 # "<project> v<release> documentation". 100 # "<project> v<release> documentation".
106 #html_title = None 101 #html_title = None
107 102
118 #html_favicon = None 113 #html_favicon = None
119 114
120 # Add any paths that contain custom static files (such as style sheets) here, 115 # Add any paths that contain custom static files (such as style sheets) here,
121 # relative to this directory. They are copied after the builtin static files, 116 # relative to this directory. They are copied after the builtin static files,
122 # so a file named "default.css" will overwrite the builtin "default.css". 117 # so a file named "default.css" will overwrite the builtin "default.css".
123 html_static_path = ['_static'] 118 html_static_path = ['.static']
124 119
125 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 120 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
126 # using the given strftime format. 121 # using the given strftime format.
127 #html_last_updated_fmt = '%b %d, %Y' 122 #html_last_updated_fmt = '%b %d, %Y'
128 123
144 #html_use_index = True 139 #html_use_index = True
145 140
146 # If true, the index is split into individual pages for each letter. 141 # If true, the index is split into individual pages for each letter.
147 #html_split_index = False 142 #html_split_index = False
148 143
149 # If true, links to the reST sources are added to the pages. 144 # If true, the reST sources are included in the HTML build as _sources/<name>.
150 #html_show_sourcelink = True 145 #html_copy_source = True
151 146
152 # If true, an OpenSearch description file will be output, and all pages will 147 # If true, an OpenSearch description file will be output, and all pages will
153 # contain a <link> tag referring to it. The value of this option must be the 148 # contain a <link> tag referring to it. The value of this option must be the
154 # base URL from which the finished HTML is served. 149 # base URL from which the finished HTML is served.
155 #html_use_opensearch = '' 150 #html_use_opensearch = ''
156 151
157 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). 152 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
158 #html_file_suffix = '' 153 #html_file_suffix = ''
159 154
160 # Output file base name for HTML help builder. 155 # Output file base name for HTML help builder.
161 htmlhelp_basename = 'sqlpythondoc' 156 htmlhelp_basename = 'SQLPythondoc'
162 157
163 158
164 # -- Options for LaTeX output -------------------------------------------------- 159 # Options for LaTeX output
160 # ------------------------
165 161
166 # The paper size ('letter' or 'a4'). 162 # The paper size ('letter' or 'a4').
167 #latex_paper_size = 'letter' 163 #latex_paper_size = 'letter'
168 164
169 # The font size ('10pt', '11pt' or '12pt'). 165 # The font size ('10pt', '11pt' or '12pt').
170 #latex_font_size = '10pt' 166 #latex_font_size = '10pt'
171 167
172 # Grouping the document tree into LaTeX files. List of tuples 168 # Grouping the document tree into LaTeX files. List of tuples
173 # (source start file, target name, title, author, documentclass [howto/manual]). 169 # (source start file, target name, title, author, document class [howto/manual]).
174 latex_documents = [ 170 latex_documents = [
175 ('index', 'sqlpython.tex', u'sqlpython Documentation', 171 ('index', 'SQLPython.tex', ur'SQLPython Documentation',
176 u'Catherine Devlin', 'manual'), 172 ur'Catherine Devlin', 'manual'),
177 ] 173 ]
178 174
179 # The name of an image file (relative to this directory) to place at the top of 175 # The name of an image file (relative to this directory) to place at the top of
180 # the title page. 176 # the title page.
181 #latex_logo = None 177 #latex_logo = None