My favorites | Sign in
Project Home Downloads Wiki Issues Source
Repository:
Checkout   Browse   Changes   Clones  
Changes to /doc-src/manual/conf.py
5c48a1540abd vs. 431aadb3c826 Compare: vs.  Format:
Revision 431aadb3c826
Go to: 
Project members, sign in to write a code review
/doc-src/manual/conf.py   5c48a1540abd /doc-src/manual/conf.py   431aadb3c826
1 # -*- coding: utf-8 -*- 1 # -*- coding: utf-8 -*-
2 # 2 #
3 # LEPL documentation build configuration file, created by 3 # LEPL documentation build configuration file, created by
4 # sphinx-quickstart on Tue Jan 13 21:16:46 2009. 4 # sphinx-quickstart on Tue Jan 13 21:16:46 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 # 7 #
8 # The contents of this file are pickled, so don't put values in the namespace 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). 9 # that aren't pickleable (module imports are okay, they're removed automatically).
10 # 10 #
11 # Note that not all possible configuration values are present in this 11 # Note that not all possible configuration values are present in this
12 # autogenerated file. 12 # autogenerated file.
13 # 13 #
14 # All configuration values have a default; values that are commented out 14 # All configuration values have a default; values that are commented out
15 # serve to show the default. 15 # serve to show the default.
16 16
17 import sys, os 17 import sys, os
18 18
19 # If your extensions are in another directory, add it here. If the directory 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 20 # is relative to the documentation root, use os.path.abspath to make it
21 # absolute, like shown here. 21 # absolute, like shown here.
22 #sys.path.append(os.path.abspath('.')) 22 #sys.path.append(os.path.abspath('.'))
23 23
24 # General configuration 24 # General configuration
25 # --------------------- 25 # ---------------------
26 26
27 # 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
28 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 28 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
29 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest'] 29 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest']
30 30
31 # Add any paths that contain templates here, relative to this directory. 31 # Add any paths that contain templates here, relative to this directory.
32 templates_path = ['.templates'] 32 templates_path = ['.templates']
33 33
34 # The suffix of source filenames. 34 # The suffix of source filenames.
35 source_suffix = '.rst' 35 source_suffix = '.rst'
36 36
37 # The encoding of source files. 37 # The encoding of source files.
38 #source_encoding = 'utf-8' 38 #source_encoding = 'utf-8'
39 39
40 # The master toctree document. 40 # The master toctree document.
41 master_doc = 'contents' 41 master_doc = 'contents'
42 42
43 # General information about the project. 43 # General information about the project.
44 project = u'LEPL' 44 project = u'LEPL'
45 copyright = u'2009-2011, Andrew Cooke' 45 copyright = u'2009-2011, Andrew Cooke'
46 46
47 # 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
48 # |version| and |release|, also used in various other places throughout the 48 # |version| and |release|, also used in various other places throughout the
49 # built documents. 49 # built documents.
50 # 50 #
51 # The short X.Y version. 51 # The short X.Y version.
52 version = '5.0' 52 version = '5.0'
53 # The full version, including alpha/beta/rc tags. 53 # The full version, including alpha/beta/rc tags.
54 release = '5.0.0' 54 release = '5.0.1'
55 55
56 # The language for content autogenerated by Sphinx. Refer to documentation 56 # The language for content autogenerated by Sphinx. Refer to documentation
57 # for a list of supported languages. 57 # for a list of supported languages.
58 #language = None 58 #language = None
59 59
60 # There are two options for replacing |today|: either, you set today to some 60 # There are two options for replacing |today|: either, you set today to some
61 # non-false value, then it is used: 61 # non-false value, then it is used:
62 #today = '' 62 #today = ''
63 # Else, today_fmt is used as the fmt for a strftime call. 63 # Else, today_fmt is used as the fmt for a strftime call.
64 #today_fmt = '%B %d, %Y' 64 #today_fmt = '%B %d, %Y'
65 65
66 # List of documents that shouldn't be included in the build. 66 # List of documents that shouldn't be included in the build.
67 #unused_docs = [] 67 #unused_docs = []
68 68
69 # List of directories, relative to source directory, that shouldn't be searched 69 # List of directories, relative to source directory, that shouldn't be searched
70 # for source files. 70 # for source files.
71 exclude_trees = ['.build'] 71 exclude_trees = ['.build']
72 72
73 # The reST default role (used for this markup: `text`) to use for all documents. 73 # The reST default role (used for this markup: `text`) to use for all documents.
74 #default_role = None 74 #default_role = None
75 75
76 # If true, '()' will be appended to :func: etc. cross-reference text. 76 # If true, '()' will be appended to :func: etc. cross-reference text.
77 #add_function_parentheses = True 77 #add_function_parentheses = True
78 78
79 # If true, the current module name will be prepended to all description 79 # If true, the current module name will be prepended to all description
80 # unit titles (such as .. function::). 80 # unit titles (such as .. function::).
81 #add_module_names = True 81 #add_module_names = True
82 82
83 # If true, sectionauthor and moduleauthor directives will be shown in the 83 # If true, sectionauthor and moduleauthor directives will be shown in the
84 # output. They are ignored by default. 84 # output. They are ignored by default.
85 #show_authors = False 85 #show_authors = False
86 86
87 # The name of the Pygments (syntax highlighting) style to use. 87 # The name of the Pygments (syntax highlighting) style to use.
88 pygments_style = 'bw' 88 pygments_style = 'bw'
89 89
90 90
91 # Options for HTML output 91 # Options for HTML output
92 # ----------------------- 92 # -----------------------
93 93
94 # The style sheet to use for HTML and HTML Help pages. A file of that name 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 95 # must exist either in Sphinx' static/ path, or in one of the custom paths
96 # given in html_static_path. 96 # given in html_static_path.
97 #html_style = 'default.css' 97 #html_style = 'default.css'
98 html_theme = 'sphinx' 98 html_theme = 'sphinx'
99 html_theme_path = ['.'] 99 html_theme_path = ['.']
100 html_theme_options = { 100 html_theme_options = {
101 'footerbgcolor': 'white', 101 'footerbgcolor': 'white',
102 'footertextcolor': 'black', 102 'footertextcolor': 'black',
103 'sidebarbgcolor': 'white', 103 'sidebarbgcolor': 'white',
104 'sidebartextcolor': 'black', 104 'sidebartextcolor': 'black',
105 'sidebarlinkcolor': '#680', 105 'sidebarlinkcolor': '#680',
106 'relbarbgcolor': 'white', 106 'relbarbgcolor': 'white',
107 'relbartextcolor': 'black', 107 'relbartextcolor': 'black',
108 'relbarlinkcolor': '#680', 108 'relbarlinkcolor': '#680',
109 'bgcolor': 'white', 109 'bgcolor': 'white',
110 'textcolor': 'black', 110 'textcolor': 'black',
111 'linkcolor': '#680', 111 'linkcolor': '#680',
112 'headbgcolor': 'white', 112 'headbgcolor': 'white',
113 'headtextcolor': 'black', 113 'headtextcolor': 'black',
114 'headlinkcolor': '#680', 114 'headlinkcolor': '#680',
115 'codebgcolor': 'white', 115 'codebgcolor': 'white',
116 'codetextcolor': 'black', 116 'codetextcolor': 'black',
117 'bodyfont': 'serif', 117 'bodyfont': 'serif',
118 'headfont': 'serif', 118 'headfont': 'serif',
119 119
120 # 'footerbgcolor': '#111', 120 # 'footerbgcolor': '#111',
121 # 'footertextcolor': '#ccc', 121 # 'footertextcolor': '#ccc',
122 # 'sidebarbgcolor': '#111', 122 # 'sidebarbgcolor': '#111',
123 # 'sidebartextcolor': '#ccc', 123 # 'sidebartextcolor': '#ccc',
124 # 'sidebarlinkcolor': '#480', 124 # 'sidebarlinkcolor': '#480',
125 # 'relbarbgcolor': '#111', 125 # 'relbarbgcolor': '#111',
126 # 'relbartextcolor': '#ccc', 126 # 'relbartextcolor': '#ccc',
127 # 'relbarlinkcolor': '#480', 127 # 'relbarlinkcolor': '#480',
128 # 'bgcolor': '#111', 128 # 'bgcolor': '#111',
129 # 'textcolor': '#ccc', 129 # 'textcolor': '#ccc',
130 # 'linkcolor': '#480', 130 # 'linkcolor': '#480',
131 # 'headbgcolor': '#111', 131 # 'headbgcolor': '#111',
132 # 'headtextcolor': '#ccc', 132 # 'headtextcolor': '#ccc',
133 # 'headlinkcolor': '#480', 133 # 'headlinkcolor': '#480',
134 # 'codebgcolor': '#111', 134 # 'codebgcolor': '#111',
135 # 'codetextcolor': '#ccc', 135 # 'codetextcolor': '#ccc',
136 # 'bodyfont': 'serif', 136 # 'bodyfont': 'serif',
137 # 'headfont': 'serif', 137 # 'headfont': 'serif',
138 } 138 }
139 139
140 # The name for this set of Sphinx documents. If None, it defaults to 140 # The name for this set of Sphinx documents. If None, it defaults to
141 # "<project> v<release> documentation". 141 # "<project> v<release> documentation".
142 #html_title = None 142 #html_title = None
143 143
144 # A shorter title for the navigation bar. Default is the same as html_title. 144 # A shorter title for the navigation bar. Default is the same as html_title.
145 #html_short_title = None 145 #html_short_title = None
146 146
147 # The name of an image file (relative to this directory) to place at the top 147 # The name of an image file (relative to this directory) to place at the top
148 # of the sidebar. 148 # of the sidebar.
149 #html_logo = None 149 #html_logo = None
150 150
151 # The name of an image file (within the static path) to use as favicon of the 151 # The name of an image file (within the static path) to use as favicon of the
152 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 152 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
153 # pixels large. 153 # pixels large.
154 #html_favicon = None 154 #html_favicon = None
155 155
156 # Add any paths that contain custom static files (such as style sheets) here, 156 # Add any paths that contain custom static files (such as style sheets) here,
157 # relative to this directory. They are copied after the builtin static files, 157 # relative to this directory. They are copied after the builtin static files,
158 # so a file named "default.css" will overwrite the builtin "default.css". 158 # so a file named "default.css" will overwrite the builtin "default.css".
159 html_static_path = ['.static'] 159 html_static_path = ['.static']
160 160
161 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 161 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
162 # using the given strftime fmt. 162 # using the given strftime fmt.
163 #html_last_updated_fmt = '%b %d, %Y' 163 #html_last_updated_fmt = '%b %d, %Y'
164 164
165 # If true, SmartyPants will be used to convert quotes and dashes to 165 # If true, SmartyPants will be used to convert quotes and dashes to
166 # typographically correct entities. 166 # typographically correct entities.
167 #html_use_smartypants = True 167 #html_use_smartypants = True
168 168
169 # Custom sidebar templates, maps document names to template names. 169 # Custom sidebar templates, maps document names to template names.
170 #html_sidebars = {} 170 #html_sidebars = {}
171 171
172 # Additional templates that should be rendered to pages, maps page names to 172 # Additional templates that should be rendered to pages, maps page names to
173 # template names. 173 # template names.
174 #html_additional_pages = {} 174 #html_additional_pages = {}
175 175
176 # If false, no module index is generated. 176 # If false, no module index is generated.
177 #html_use_modindex = True 177 #html_use_modindex = True
178 178
179 # If false, no index is generated. 179 # If false, no index is generated.
180 #html_use_index = True 180 #html_use_index = True
181 181
182 # If true, the index is split into individual pages for each letter. 182 # If true, the index is split into individual pages for each letter.
183 #html_split_index = False 183 #html_split_index = False
184 184
185 # If true, the reST sources are included in the HTML build as _sources/<name>. 185 # If true, the reST sources are included in the HTML build as _sources/<name>.
186 #html_copy_source = True 186 #html_copy_source = True
187 187
188 # If true, an OpenSearch description file will be output, and all pages will 188 # If true, an OpenSearch description file will be output, and all pages will
189 # contain a <link> tag referring to it. The value of this option must be the 189 # contain a <link> tag referring to it. The value of this option must be the
190 # base URL from which the finished HTML is served. 190 # base URL from which the finished HTML is served.
191 #html_use_opensearch = '' 191 #html_use_opensearch = ''
192 192
193 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). 193 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
194 #html_file_suffix = '' 194 #html_file_suffix = ''
195 195
196 # Output file base name for HTML help builder. 196 # Output file base name for HTML help builder.
197 htmlhelp_basename = 'LEPLdoc' 197 htmlhelp_basename = 'LEPLdoc'
198 198
199 199
200 # Options for LaTeX output 200 # Options for LaTeX output
201 # ------------------------ 201 # ------------------------
202 202
203 # The paper size ('letter' or 'a4'). 203 # The paper size ('letter' or 'a4').
204 #latex_paper_size = 'letter' 204 #latex_paper_size = 'letter'
205 205
206 # The font size ('10pt', '11pt' or '12pt'). 206 # The font size ('10pt', '11pt' or '12pt').
207 #latex_font_size = '10pt' 207 #latex_font_size = '10pt'
208 208
209 # Grouping the document tree into LaTeX files. List of tuples 209 # Grouping the document tree into LaTeX files. List of tuples
210 # (source start file, target name, title, author, document class [howto/manual]). 210 # (source start file, target name, title, author, document class [howto/manual]).
211 latex_documents = [ 211 latex_documents = [
212 ('index', 'LEPL.tex', ur'LEPL Documentation', 212 ('index', 'LEPL.tex', ur'LEPL Documentation',
213 ur'Andrew Cooke', 'manual'), 213 ur'Andrew Cooke', 'manual'),
214 ] 214 ]
215 215
216 # The name of an image file (relative to this directory) to place at the top of 216 # The name of an image file (relative to this directory) to place at the top of
217 # the title page. 217 # the title page.
218 #latex_logo = None 218 #latex_logo = None
219 219
220 # For "manual" documents, if this is true, then toplevel headings are parts, 220 # For "manual" documents, if this is true, then toplevel headings are parts,
221 # not chapters. 221 # not chapters.
222 #latex_use_parts = False 222 #latex_use_parts = False
223 223
224 # Additional stuff for the LaTeX preamble. 224 # Additional stuff for the LaTeX preamble.
225 #latex_preamble = '' 225 #latex_preamble = ''
226 226
227 # Documents to append as an appendix to all manuals. 227 # Documents to append as an appendix to all manuals.
228 #latex_appendices = [] 228 #latex_appendices = []
229 229
230 # If false, no module index is generated. 230 # If false, no module index is generated.
231 #latex_use_modindex = True 231 #latex_use_modindex = True
232 232
233 233
234 234
235 # ------------------- 235 # -------------------
236 236
237 doctest_path = '/home/andrew/projects/personal/src/python/lepl/src' 237 doctest_path = '/home/andrew/projects/personal/src/python/lepl/src'
Powered by Google Project Hosting