source: orange/docs/extend-widgets/rst/conf.py @ 9917:faac299dfd6e

Revision 9917:faac299dfd6e, 7.9 KB checked in by Matija Polajnar <matija.polajnar@…>, 2 years ago (diff)

Move QT widget writing documentation out of reference.

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