Merge branch 'master' of ssh://git.labs.libre-entreprise.org/gitroot/tiramisu
[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     "footerbgcolor": "black"
101     }
102
103
104 # Theme options are theme-specific and customize the look and feel of a theme
105 # further.  For a list of options available for each theme, see the
106 # documentation.
107 #html_theme_options = {}
108
109 # Add any paths that contain custom themes here, relative to this directory.
110 #html_theme_path = []
111
112 # The name for this set of Sphinx documents.  If None, it defaults to
113 # "<project> v<release> documentation".
114 #html_title = None
115
116 # A shorter title for the navigation bar.  Default is the same as html_title.
117 #html_short_title = None
118
119 # The name of an image file (relative to this directory) to place at the top
120 # of the sidebar.
121 #html_logo = None
122
123 # The name of an image file (within the static path) to use as favicon of the
124 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
125 # pixels large.
126 #html_favicon = None
127
128 # Add any paths that contain custom static files (such as style sheets) here,
129 # relative to this directory. They are copied after the builtin static files,
130 # so a file named "default.css" will overwrite the builtin "default.css".
131 html_static_path = ['_static']
132
133 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
134 # using the given strftime format.
135 #html_last_updated_fmt = '%b %d, %Y'
136
137 # If true, SmartyPants will be used to convert quotes and dashes to
138 # typographically correct entities.
139 #html_use_smartypants = True
140
141 # Custom sidebar templates, maps document names to template names.
142 #html_sidebars = {}
143
144 # Additional templates that should be rendered to pages, maps page names to
145 # template names.
146 #html_additional_pages = {}
147
148 # If false, no module index is generated.
149 #html_domain_indices = True
150
151 # If false, no index is generated.
152 #html_use_index = True
153
154 # If true, the index is split into individual pages for each letter.
155 #html_split_index = False
156
157 # If true, links to the reST sources are added to the pages.
158 #html_show_sourcelink = True
159
160 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
161 #html_show_sphinx = True
162
163 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
164 #html_show_copyright = True
165
166 # If true, an OpenSearch description file will be output, and all pages will
167 # contain a <link> tag referring to it.  The value of this option must be the
168 # base URL from which the finished HTML is served.
169 #html_use_opensearch = ''
170
171 # This is the file name suffix for HTML files (e.g. ".xhtml").
172 #html_file_suffix = None
173
174 # Output file base name for HTML help builder.
175 htmlhelp_basename = 'tiramisudoc'
176
177
178 # -- Options for LaTeX output --------------------------------------------------
179
180 latex_elements = {
181 # The paper size ('letterpaper' or 'a4paper').
182 #'papersize': 'letterpaper',
183
184 # The font size ('10pt', '11pt' or '12pt').
185 #'pointsize': '10pt',
186
187 # Additional stuff for the LaTeX preamble.
188 #'preamble': '',
189 }
190
191 # Grouping the document tree into LaTeX files. List of tuples
192 # (source start file, target name, title, author, documentclass [howto/manual]).
193 latex_documents = [
194   ('index', 'tiramisu.tex', u'tiramisu Documentation',
195    u'gwen', 'manual'),
196 ]
197
198 # The name of an image file (relative to this directory) to place at the top of
199 # the title page.
200 #latex_logo = None
201
202 # For "manual" documents, if this is true, then toplevel headings are parts,
203 # not chapters.
204 #latex_use_parts = False
205
206 # If true, show page references after internal links.
207 #latex_show_pagerefs = False
208
209 # If true, show URL addresses after external links.
210 #latex_show_urls = False
211
212 # Documents to append as an appendix to all manuals.
213 #latex_appendices = []
214
215 # If false, no module index is generated.
216 #latex_domain_indices = True
217
218
219 # -- Options for manual page output --------------------------------------------
220
221 # One entry per manual page. List of tuples
222 # (source start file, name, description, authors, manual section).
223 man_pages = [
224     ('index', 'tiramisu', u'tiramisu Documentation',
225      [u'gwen'], 1)
226 ]
227
228 # If true, show URL addresses after external links.
229 #man_show_urls = False
230
231
232 # -- Options for Texinfo output ------------------------------------------------
233
234 # Grouping the document tree into Texinfo files. List of tuples
235 # (source start file, target name, title, author,
236 #  dir menu entry, description, category)
237 texinfo_documents = [
238   ('index', 'tiramisu', u'tiramisu Documentation',
239    u'gwen', 'tiramisu', 'One line description of project.',
240    'Miscellaneous'),
241 ]
242
243 # Documents to append as an appendix to all manuals.
244 #texinfo_appendices = []
245
246 # If false, no module index is generated.
247 #texinfo_domain_indices = True
248
249 # How to display URL addresses: 'footnote', 'no', or 'inline'.
250 #texinfo_show_urls = 'footnote'
251
252
253 # -- Options for Epub output ---------------------------------------------------
254
255 # Bibliographic Dublin Core info.
256 epub_title = u'tiramisu'
257 epub_author = u'gwen'
258 epub_publisher = u'gwen'
259 epub_copyright = u'2012, gwen'
260
261 # The language of the text. It defaults to the language option
262 # or en if the language is not set.
263 #epub_language = ''
264
265 # The scheme of the identifier. Typical schemes are ISBN or URL.
266 #epub_scheme = ''
267
268 # The unique identifier of the text. This can be a ISBN number
269 # or the project homepage.
270 #epub_identifier = ''
271
272 # A unique identification for the text.
273 #epub_uid = ''
274
275 # A tuple containing the cover image and cover page html template filenames.
276 #epub_cover = ()
277
278 # HTML files that should be inserted before the pages created by sphinx.
279 # The format is a list of tuples containing the path and title.
280 #epub_pre_files = []
281
282 # HTML files shat should be inserted after the pages created by sphinx.
283 # The format is a list of tuples containing the path and title.
284 #epub_post_files = []
285
286 # A list of files that should not be packed into the epub file.
287 #epub_exclude_files = []
288
289 # The depth of the table of contents in toc.ncx.
290 #epub_tocdepth = 3
291
292 # Allow duplicate toc entries.
293 #epub_tocdup = True
294
295 todo_include_todos = True
296
297 extlinks = {'api': ('./api/tiramisu.%s', ""),
298                 'test': ('./api/test.%s', "")}