source: orange/docs/tutorial/rst/conf.py @ 9387:4cfea82363ea

Revision 9387:4cfea82363ea, 7.8 KB checked in by mitar, 2 years ago (diff)

Structuring widgets documentation.

Line 
1# -*- coding: utf-8 -*-
2#
3# tutorial documentation build configuration file, created by
4# sphinx-quickstart on Fri Jul 16 13:29:06 2010.
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
14import 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.append(os.path.abspath('.'))
20
21# -- General configuration -----------------------------------------------------
22
23# Add any Sphinx extension module names here, as strings. They can be extensions
24# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
25extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.pngmath']
26
27# Add any paths that contain templates here, relative to this directory.
28templates_path = ['_templates']
29
30# The suffix of source filenames.
31source_suffix = '.rst'
32
33# The encoding of source files.
34#source_encoding = 'utf-8'
35
36# The master toctree document.
37master_doc = 'index'
38
39# General information about the project.
40project = u'Orange'
41copyright = u'Bioinformatics Laboratory, FRI UL'
42
43# 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
45# built documents.
46#
47# The short X.Y version.
48version = '2.5'
49# The full version, including alpha/beta/rc tags.
50release = '2.5 beta'
51
52# The language for content autogenerated by Sphinx. Refer to documentation
53# for a list of supported languages.
54#language = None
55
56# There are two options for replacing |today|: either, you set today to some
57# non-false value, then it is used:
58#today = ''
59# Else, today_fmt is used as the format for a strftime call.
60#today_fmt = '%B %d, %Y'
61
62# List of documents that shouldn't be included in the build.
63#unused_docs = []
64
65# List of directories, relative to source directory, that shouldn't be searched
66# for source files.
67exclude_trees = ['_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.
84pygments_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.  Major themes that come with
93# Sphinx are currently 'default' and 'sphinxdoc'.
94html_theme = 'orange_theme'
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.
99html_theme_options = {"collapsiblesidebar": "false"}
100
101if html_theme == "orange_theme":
102    html_theme_options.update({"orangeheaderfooter": "false"})
103
104# Add any paths that contain custom themes here, relative to this directory.
105html_theme_path = ["../../sphinx-ext/themes"]
106
107# The name for this set of Sphinx documents.  If None, it defaults to
108# "<project> v<release> documentation".
109html_title = "Orange Tutorial"
110
111# A shorter title for the navigation bar.  Default is the same as html_title.
112#html_short_title = None
113
114# The name of an image file (relative to this directory) to place at the top
115# of the sidebar.
116#html_logo = None
117
118# The name of an image file (within the static path) to use as favicon of the
119# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
120# pixels large.
121#html_favicon = None
122
123# Add any paths that contain custom static files (such as style sheets) here,
124# relative to this directory. They are copied after the builtin static files,
125# so a file named "default.css" will overwrite the builtin "default.css".
126html_static_path = []
127
128# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
129# using the given strftime format.
130#html_last_updated_fmt = '%b %d, %Y'
131
132# If true, SmartyPants will be used to convert quotes and dashes to
133# typographically correct entities.
134#html_use_smartypants = True
135
136# Custom sidebar templates, maps document names to template names.
137#html_sidebars = {}
138
139# Additional templates that should be rendered to pages, maps page names to
140# template names.
141#html_additional_pages = {}
142
143# If false, no module index is generated.
144#html_use_modindex = True
145
146# If false, no index is generated.
147#html_use_index = True
148
149# If true, the index is split into individual pages for each letter.
150#html_split_index = False
151
152# If true, links to the reST sources are added to the pages.
153#html_show_sourcelink = True
154
155# If true, an OpenSearch description file will be output, and all pages will
156# contain a <link> tag referring to it.  The value of this option must be the
157# base URL from which the finished HTML is served.
158#html_use_opensearch = ''
159
160# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
161#html_file_suffix = ''
162
163# Output file base name for HTML help builder.
164htmlhelp_basename = 'tutorialdoc'
165
166
167# -- Options for LaTeX output --------------------------------------------------
168
169# The paper size ('letter' or 'a4').
170#latex_paper_size = 'letter'
171
172# The font size ('10pt', '11pt' or '12pt').
173#latex_font_size = '10pt'
174
175# Grouping the document tree into LaTeX files. List of tuples
176# (source start file, target name, title, author, documentclass [howto/manual]).
177latex_documents = [
178  ('index', 'tutorial.tex', u'Tutorial',
179   u'Biolab', 'manual'),
180]
181
182# The name of an image file (relative to this directory) to place at the top of
183# the title page.
184#latex_logo = None
185
186# For "manual" documents, if this is true, then toplevel headings are parts,
187# not chapters.
188#latex_use_parts = False
189
190# Additional stuff for the LaTeX preamble.
191#latex_preamble = ''
192
193# Documents to append as an appendix to all manuals.
194#latex_appendices = []
195
196# If false, no module index is generated.
197#latex_use_modindex = True
198
199# -- Options for Epub output ---------------------------------------------------
200
201# Bibliographic Dublin Core info.
202epub_title = u'Orange Tutorial'
203epub_author = u'Biolab'
204epub_publisher = u'Biolab'
205epub_copyright = u'Bioinformatics Laboratory, FRI UL'
206
207# The language of the text. It defaults to the language option
208# or en if the language is not set.
209epub_language = 'en'
210
211# The scheme of the identifier. Typical schemes are ISBN or URL.
212#epub_scheme = ''
213
214# The unique identifier of the text. This can be a ISBN number
215# or the project homepage.
216#epub_identifier = ''
217
218# A unique identification for the text.
219#epub_uid = ''
220
221# HTML files that should be inserted before the pages created by sphinx.
222# The format is a list of tuples containing the path and title.
223#epub_pre_files = []
224
225# HTML files that should be inserted after the pages created by sphinx.
226# The format is a list of tuples containing the path and title.
227#epub_post_files = []
228
229# A list of files that should not be packed into the epub file.
230epub_exclude_files = ["index.html", "genindex.html", "py-modindex.html", "search.html"]
231
232# The depth of the table of contents in toc.ncx.
233#epub_tocdepth = 3
234
235# Allow duplicate toc entries.
236#epub_tocdup = True
237
238# Example configuration for intersphinx: refer to the Python standard library.
239intersphinx_mapping = {
240    'python': ('http://docs.python.org/', None),
241    'reference': ('http://orange.biolab.si/doc/reference/', 'http://orange.biolab.si/doc/reference/_objects/'),
242}
Note: See TracBrowser for help on using the repository browser.