source: orange-reliability/docs/rst/conf.py @ 20:a5acdf15091f

Revision 20:a5acdf15091f, 7.4 KB checked in by Matija Polajnar <matija.polajnar@…>, 20 months ago (diff)

Fix readthedocs documentation building issues. Hopefully.

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