source: orange-bioinformatics/docs/rst/conf.py @ 1665:9608dd9c7656

Revision 1665:9608dd9c7656, 7.1 KB checked in by mitar, 2 years ago (diff)

Unifying documentation.

Line 
1# -*- coding: utf-8 -*-
2#
3# This file is execfile()d with the current directory set to its containing dir.
4#
5# Note that not all possible configuration values are present in this
6# autogenerated file.
7#
8# All configuration values have a default; values that are commented out
9# serve to show the default.
10
11import sys, os
12
13import imp
14module_setup = imp.load_source('module_setup', os.path.join(os.path.dirname(__file__), '..', '..', 'setup.py'))
15VERSION = module_setup.VERSION
16AUTHOR = module_setup.AUTHOR
17NAME = module_setup.NAME
18
19TITLE = "%s v%s documentation" % (NAME, VERSION)
20
21# If extensions (or modules to document with autodoc) are in another directory,
22# add these directories to sys.path here. If the directory is relative to the
23# documentation root, use os.path.abspath to make it absolute, like shown here.
24#sys.path.append(os.path.abspath('.'))
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 = NAME
46copyright = AUTHOR
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 = 'nature'
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.
104#html_theme_options = {}
105
106# Add any paths that contain custom themes here, relative to this directory.
107#html_theme_path = []
108
109# The name for this set of Sphinx documents.  If None, it defaults to
110# "<project> v<release> documentation".
111html_title = TITLE
112
113# A shorter title for the navigation bar.  Default is the same as html_title.
114#html_short_title = None
115
116# The name of an image file (relative to this directory) to place at the top
117# of the sidebar.
118#html_logo = None
119
120# The name of an image file (within the static path) to use as favicon of the
121# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
122# pixels large.
123#html_favicon = None
124
125# Add any paths that contain custom static files (such as style sheets) here,
126# relative to this directory. They are copied after the builtin static files,
127# so a file named "default.css" will overwrite the builtin "default.css".
128html_static_path = ['_static']
129
130# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
131# using the given strftime format.
132#html_last_updated_fmt = '%b %d, %Y'
133
134# If true, SmartyPants will be used to convert quotes and dashes to
135# typographically correct entities.
136#html_use_smartypants = True
137
138# Custom sidebar templates, maps document names to template names.
139#html_sidebars = {}
140
141# Additional templates that should be rendered to pages, maps page names to
142# template names.
143#html_additional_pages = {}
144
145# If false, no module index is generated.
146#html_domain_indices = True
147
148# If false, no index is generated.
149#html_use_index = True
150
151# If true, the index is split into individual pages for each letter.
152#html_split_index = False
153
154# If true, links to the reST sources are added to the pages.
155#html_show_sourcelink = True
156
157# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
158html_show_sphinx = False
159
160# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
161html_show_copyright = False
162
163# If true, an OpenSearch description file will be output, and all pages will
164# contain a <link> tag referring to it.  The value of this option must be the
165# base URL from which the finished HTML is served.
166#html_use_opensearch = ''
167
168# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
169#html_file_suffix = ''
170
171# Output file base name for HTML help builder.
172htmlhelp_basename = 'addon'
173
174
175# -- Options for LaTeX output --------------------------------------------------
176
177# The paper size ('letter' or 'a4').
178#latex_paper_size = 'letter'
179
180# The font size ('10pt', '11pt' or '12pt').
181#latex_font_size = '10pt'
182
183# Grouping the document tree into LaTeX files. List of tuples
184# (source start file, target name, title, author, documentclass [howto/manual]).
185latex_documents = [
186  ('index', 'addon.tex', html_title,
187   copyright, 'manual'),
188]
189
190# The name of an image file (relative to this directory) to place at the top of
191# the title page.
192#latex_logo = None
193
194# For "manual" documents, if this is true, then toplevel headings are parts,
195# not chapters.
196#latex_use_parts = False
197
198# If true, show page references after internal links.
199#latex_show_pagerefs = False
200
201# If true, show URL addresses after external links.
202#latex_show_urls = False
203
204# Additional stuff for the LaTeX preamble.
205#latex_preamble = ''
206
207# Documents to append as an appendix to all manuals.
208#latex_appendices = []
209
210# If false, no module index is generated.
211#latex_domain_indices = True
212
213# -- Options for manual page output --------------------------------------------
214
215# One entry per manual page. List of tuples
216# (source start file, name, description, authors, manual section).
217man_pages = [
218    ('index', 'addon', TITLE,
219     [AUTHOR], 1)
220]
221
222# Example configuration for intersphinx: refer to the Python standard library.
223intersphinx_mapping = {
224    'python': ('http://python.readthedocs.org/en/latest/', None),
225}
226
Note: See TracBrowser for help on using the repository browser.