source: orange-bioinformatics/docs/reference/rst/conf.py @ 1662:427f1876f3e6

Revision 1662:427f1876f3e6, 7.3 KB checked in by mitar, 2 years ago (diff)

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