source: orange/docs/development/rst/conf.py @ 10881:f22adc7ab645

Revision 10881:f22adc7ab645, 8.1 KB checked in by mitar, 2 years ago (diff)

Use current version in documentation.

Line 
1# -*- coding: utf-8 -*-
2#
3# orange library development documentation build configuration file, created by
4# sphinx-quickstart on Fri Oct  8 15:09:05 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
16import imp
17module_setup = imp.load_source('module_setup', os.path.join(os.path.dirname(__file__), '..', '..', '..', 'setup.py'))
18VERSION = module_setup.VERSION
19
20# If extensions (or modules to document with autodoc) are in another directory,
21# add these directories to sys.path here. If the directory is relative to the
22# documentation root, use os.path.abspath to make it absolute, like shown here.
23sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '../../../')))
24import Orange
25
26# -- General configuration -----------------------------------------------------
27
28# Add any Sphinx extension module names here, as strings. They can be extensions
29# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
30extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.pngmath']
31
32# Add any paths that contain templates here, relative to this directory.
33templates_path = ['_templates']
34
35# The suffix of source filenames.
36source_suffix = '.rst'
37
38# The encoding of source files.
39#source_encoding = 'utf-8'
40
41# The master toctree document.
42master_doc = 'index'
43
44# General information about the project.
45project = u'Orange'
46copyright = u'Bioinformatics Laboratory, FRI UL'
47
48# The version info for the project you're documenting, acts as replacement for
49# |version| and |release|, also used in various other places throughout the
50# built documents.
51#
52# The short X.Y version.
53version = VERSION
54# The full version, including alpha/beta/rc tags.
55release = VERSION
56
57# The language for content autogenerated by Sphinx. Refer to documentation
58# for a list of supported languages.
59#language = None
60
61# There are two options for replacing |today|: either, you set today to some
62# non-false value, then it is used:
63#today = ''
64# Else, today_fmt is used as the format for a strftime call.
65#today_fmt = '%B %d, %Y'
66
67# List of documents that shouldn't be included in the build.
68#unused_docs = []
69
70# List of directories, relative to source directory, that shouldn't be searched
71# for source files.
72exclude_trees = ['_build']
73
74# The reST default role (used for this markup: `text`) to use for all documents.
75#default_role = None
76
77# If true, '()' will be appended to :func: etc. cross-reference text.
78#add_function_parentheses = True
79
80# If true, the current module name will be prepended to all description
81# unit titles (such as .. function::).
82#add_module_names = True
83
84# If true, sectionauthor and moduleauthor directives will be shown in the
85# output. They are ignored by default.
86#show_authors = False
87
88# The name of the Pygments (syntax highlighting) style to use.
89pygments_style = 'sphinx'
90
91# A list of ignored prefixes for module index sorting.
92#modindex_common_prefix = []
93
94
95# -- Options for HTML output ---------------------------------------------------
96
97# The theme to use for HTML and HTML Help pages.  Major themes that come with
98# Sphinx are currently 'default' and 'sphinxdoc'.
99html_theme = 'orange_theme'
100
101# Theme options are theme-specific and customize the look and feel of a theme
102# further.  For a list of options available for each theme, see the
103# documentation.
104html_theme_options = {"collapsiblesidebar": "false"}
105
106if html_theme == "orange_theme":
107    html_theme_options.update({"orangeheaderfooter": "false"})
108
109# Add any paths that contain custom themes here, relative to this directory.
110html_theme_path = ["../../sphinx-ext/themes"]
111
112# The name for this set of Sphinx documents.  If None, it defaults to
113# "<project> v<release> documentation".
114html_title = "Orange Library Development"
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".
131html_static_path = []
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_use_modindex = 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, an OpenSearch description file will be output, and all pages will
161# contain a <link> tag referring to it.  The value of this option must be the
162# base URL from which the finished HTML is served.
163#html_use_opensearch = ''
164
165# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
166#html_file_suffix = ''
167
168# Output file base name for HTML help builder.
169htmlhelp_basename = 'developmentsdoc'
170
171
172# -- Options for LaTeX output --------------------------------------------------
173
174# The paper size ('letter' or 'a4').
175#latex_paper_size = 'letter'
176
177# The font size ('10pt', '11pt' or '12pt').
178#latex_font_size = '10pt'
179
180# Grouping the document tree into LaTeX files. List of tuples
181# (source start file, target name, title, author, documentclass [howto/manual]).
182latex_documents = [
183  ('index', 'development.tex', u'Orange Library Development',
184   u'Biolab', 'manual'),
185]
186
187# The name of an image file (relative to this directory) to place at the top of
188# the title page.
189#latex_logo = None
190
191# For "manual" documents, if this is true, then toplevel headings are parts,
192# not chapters.
193#latex_use_parts = False
194
195# Additional stuff for the LaTeX preamble.
196#latex_preamble = ''
197
198# Documents to append as an appendix to all manuals.
199#latex_appendices = []
200
201# If false, no module index is generated.
202#latex_use_modindex = True
203
204# -- Options for Epub output ---------------------------------------------------
205
206# Bibliographic Dublin Core info.
207epub_title = u'Orange Library Development'
208epub_author = u'Biolab'
209epub_publisher = u'Biolab'
210epub_copyright = u'Bioinformatics Laboratory, FRI UL'
211
212# The language of the text. It defaults to the language option
213# or en if the language is not set.
214epub_language = 'en'
215
216# The scheme of the identifier. Typical schemes are ISBN or URL.
217#epub_scheme = ''
218
219# The unique identifier of the text. This can be a ISBN number
220# or the project homepage.
221#epub_identifier = ''
222
223# A unique identification for the text.
224#epub_uid = ''
225
226# HTML files that should be inserted before the pages created by sphinx.
227# The format is a list of tuples containing the path and title.
228#epub_pre_files = []
229
230# HTML files that should be inserted after the pages created by sphinx.
231# The format is a list of tuples containing the path and title.
232#epub_post_files = []
233
234# A list of files that should not be packed into the epub file.
235epub_exclude_files = ["index.html", "genindex.html", "py-modindex.html", "search.html"]
236
237# The depth of the table of contents in toc.ncx.
238#epub_tocdepth = 3
239
240# Allow duplicate toc entries.
241#epub_tocdup = True
242
243# Example configuration for intersphinx: refer to the Python standard library.
244intersphinx_mapping = {
245    'python': ('http://docs.python.org/', None),
246    'reference': ('http://orange.biolab.si/doc/reference/', 'http://orange.biolab.si/doc/reference/_objects/'),
247}
Note: See TracBrowser for help on using the repository browser.