doc theme
[tiramisu.git] / doc / conf.py
1 # -*- coding: utf-8 -*-
2 #
3 # tiramisu documentation build configuration file, created by
4 # sphinx-quickstart on Tue Nov 20 14:29:31 2012.
5 #
6 # This file is execfile()d with the current directory set to its containing dir.
7 #
8 # Note that not all possible configuration values are present in this
9 # autogenerated file.
10 #
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
13
14 import sys, os
15
16 # If extensions (or modules to document with autodoc) are in another directory,
17 # add these directories to sys.path here. If the directory is relative to the
18 # documentation root, use os.path.abspath to make it absolute, like shown here.
19 #sys.path.insert(0, os.path.abspath('.'))
20
21 # -- General configuration -----------------------------------------------------
22
23 # If your documentation needs a minimal Sphinx version, state it here.
24 #needs_sphinx = '1.0'
25
26 # Add any Sphinx extension module names here, as strings. They can be extensions
27 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', 'sphinx.ext.autosummary', 'sphinx.ext.extlinks']
29
30 # Add any paths that contain templates here, relative to this directory.
31 templates_path = ['_templates']
32
33 # The suffix of source filenames.
34 source_suffix = '.txt'
35
36 # The encoding of source files.
37 #source_encoding = 'utf-8-sig'
38
39 # The master toctree document.
40 master_doc = 'index'
41
42 # General information about the project.
43 project = u'tiramisu'
44 copyright = u'2012, gwen'
45
46 # The version info for the project you're documenting, acts as replacement for
47 # |version| and |release|, also used in various other places throughout the
48 # built documents.
49 #
50 # The short X.Y version.
51 version = '0'
52 # The full version, including alpha/beta/rc tags.
53 release = '18'
54
55 # The language for content autogenerated by Sphinx. Refer to documentation
56 # for a list of supported languages.
57 #language = None
58
59 # There are two options for replacing |today|: either, you set today to some
60 # non-false value, then it is used:
61 #today = ''
62 # Else, today_fmt is used as the format for a strftime call.
63 #today_fmt = '%B %d, %Y'
64
65 # List of patterns, relative to source directory, that match files and
66 # directories to ignore when looking for source files.
67 exclude_patterns = ['_build']
68
69 # The reST default role (used for this markup: `text`) to use for all documents.
70 #default_role = None
71
72 # If true, '()' will be appended to :func: etc. cross-reference text.
73 #add_function_parentheses = True
74
75 # If true, the current module name will be prepended to all description
76 # unit titles (such as .. function::).
77 #add_module_names = True
78
79 # If true, sectionauthor and moduleauthor directives will be shown in the
80 # output. They are ignored by default.
81 #show_authors = False
82
83 # The name of the Pygments (syntax highlighting) style to use.
84 pygments_style = 'sphinx'
85
86 # A list of ignored prefixes for module index sorting.
87 #modindex_common_prefix = []
88
89
90 # -- Options for HTML output ---------------------------------------------------
91
92 # The theme to use for HTML and HTML Help pages.  See the documentation for
93 # a list of builtin themes.
94 html_theme = 'default'
95 html_theme_options = {
96     "rightsidebar": "true",
97     "nosidebar": "false",
98     "sidebarbgcolor": "black",
99     "relbarbgcolor": "black"
100     }
101
102
103 # Theme options are theme-specific and customize the look and feel of a theme
104 # further.  For a list of options available for each theme, see the
105 # documentation.
106 #html_theme_options = {}
107
108 # Add any paths that contain custom themes here, relative to this directory.
109 #html_theme_path = []
110
111 # The name for this set of Sphinx documents.  If None, it defaults to
112 # "<project> v<release> documentation".
113 #html_title = None
114
115 # A shorter title for the navigation bar.  Default is the same as html_title.
116 #html_short_title = None
117
118 # The name of an image file (relative to this directory) to place at the top
119 # of the sidebar.
120 #html_logo = None
121
122 # The name of an image file (within the static path) to use as favicon of the
123 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
124 # pixels large.
125 #html_favicon = None
126
127 # Add any paths that contain custom static files (such as style sheets) here,
128 # relative to this directory. They are copied after the builtin static files,
129 # so a file named "default.css" will overwrite the builtin "default.css".
130 html_static_path = ['_static']
131
132 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
133 # using the given strftime format.
134 #html_last_updated_fmt = '%b %d, %Y'
135
136 # If true, SmartyPants will be used to convert quotes and dashes to
137 # typographically correct entities.
138 #html_use_smartypants = True
139
140 # Custom sidebar templates, maps document names to template names.
141 #html_sidebars = {}
142
143 # Additional templates that should be rendered to pages, maps page names to
144 # template names.
145 #html_additional_pages = {}
146
147 # If false, no module index is generated.
148 #html_domain_indices = True
149
150 # If false, no index is generated.
151 #html_use_index = True
152
153 # If true, the index is split into individual pages for each letter.
154 #html_split_index = False
155
156 # If true, links to the reST sources are added to the pages.
157 #html_show_sourcelink = True
158
159 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
160 #html_show_sphinx = True
161
162 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
163 #html_show_copyright = True
164
165 # If true, an OpenSearch description file will be output, and all pages will
166 # contain a <link> tag referring to it.  The value of this option must be the
167 # base URL from which the finished HTML is served.
168 #html_use_opensearch = ''
169
170 # This is the file name suffix for HTML files (e.g. ".xhtml").
171 #html_file_suffix = None
172
173 # Output file base name for HTML help builder.
174 htmlhelp_basename = 'tiramisudoc'
175
176
177 # -- Options for LaTeX output --------------------------------------------------
178
179 latex_elements = {
180 # The paper size ('letterpaper' or 'a4paper').
181 #'papersize': 'letterpaper',
182
183 # The font size ('10pt', '11pt' or '12pt').
184 #'pointsize': '10pt',
185
186 # Additional stuff for the LaTeX preamble.
187 #'preamble': '',
188 }
189
190 # Grouping the document tree into LaTeX files. List of tuples
191 # (source start file, target name, title, author, documentclass [howto/manual]).
192 latex_documents = [
193   ('index', 'tiramisu.tex', u'tiramisu Documentation',
194    u'gwen', 'manual'),
195 ]
196
197 # The name of an image file (relative to this directory) to place at the top of
198 # the title page.
199 #latex_logo = None
200
201 # For "manual" documents, if this is true, then toplevel headings are parts,
202 # not chapters.
203 #latex_use_parts = False
204
205 # If true, show page references after internal links.
206 #latex_show_pagerefs = False
207
208 # If true, show URL addresses after external links.
209 #latex_show_urls = False
210
211 # Documents to append as an appendix to all manuals.
212 #latex_appendices = []
213
214 # If false, no module index is generated.
215 #latex_domain_indices = True
216
217
218 # -- Options for manual page output --------------------------------------------
219
220 # One entry per manual page. List of tuples
221 # (source start file, name, description, authors, manual section).
222 man_pages = [
223     ('index', 'tiramisu', u'tiramisu Documentation',
224      [u'gwen'], 1)
225 ]
226
227 # If true, show URL addresses after external links.
228 #man_show_urls = False
229
230
231 # -- Options for Texinfo output ------------------------------------------------
232
233 # Grouping the document tree into Texinfo files. List of tuples
234 # (source start file, target name, title, author,
235 #  dir menu entry, description, category)
236 texinfo_documents = [
237   ('index', 'tiramisu', u'tiramisu Documentation',
238    u'gwen', 'tiramisu', 'One line description of project.',
239    'Miscellaneous'),
240 ]
241
242 # Documents to append as an appendix to all manuals.
243 #texinfo_appendices = []
244
245 # If false, no module index is generated.
246 #texinfo_domain_indices = True
247
248 # How to display URL addresses: 'footnote', 'no', or 'inline'.
249 #texinfo_show_urls = 'footnote'
250
251
252 # -- Options for Epub output ---------------------------------------------------
253
254 # Bibliographic Dublin Core info.
255 epub_title = u'tiramisu'
256 epub_author = u'gwen'
257 epub_publisher = u'gwen'
258 epub_copyright = u'2012, gwen'
259
260 # The language of the text. It defaults to the language option
261 # or en if the language is not set.
262 #epub_language = ''
263
264 # The scheme of the identifier. Typical schemes are ISBN or URL.
265 #epub_scheme = ''
266
267 # The unique identifier of the text. This can be a ISBN number
268 # or the project homepage.
269 #epub_identifier = ''
270
271 # A unique identification for the text.
272 #epub_uid = ''
273
274 # A tuple containing the cover image and cover page html template filenames.
275 #epub_cover = ()
276
277 # HTML files that should be inserted before the pages created by sphinx.
278 # The format is a list of tuples containing the path and title.
279 #epub_pre_files = []
280
281 # HTML files shat should be inserted after the pages created by sphinx.
282 # The format is a list of tuples containing the path and title.
283 #epub_post_files = []
284
285 # A list of files that should not be packed into the epub file.
286 #epub_exclude_files = []
287
288 # The depth of the table of contents in toc.ncx.
289 #epub_tocdepth = 3
290
291 # Allow duplicate toc entries.
292 #epub_tocdup = True
293
294 todo_include_todos = True
295
296 extlinks = {'api': ('./api/tiramisu.%s', ""),
297                 'test': ('./api/test.%s', "")}