1
# -*- coding: utf-8 -*-
3
# OpenERP Technical Documentation configuration file, created by
4
# sphinx-quickstart on Fri Feb 17 16:14:06 2012.
6
# This file is execfile()d with the current directory set to its containing dir.
8
# Note that not all possible configuration values are present in this
11
# All configuration values have a default; values that are commented out
12
# serve to show the default.
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.
19
#sys.path.insert(0, os.path.abspath('.'))
20
sys.path.append(os.path.abspath('_themes'))
21
sys.path.append(os.path.abspath('..'))
23
# -- General configuration -----------------------------------------------------
25
# If your documentation needs a minimal Sphinx version, state it here.
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.
30
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.viewcode']
32
# Add any paths that contain templates here, relative to this directory.
33
templates_path = ['_templates']
35
# The suffix of source filenames.
36
source_suffix = '.rst'
38
# The encoding of source files.
39
#source_encoding = 'utf-8-sig'
41
# The master toctree document.
44
# General information about the project.
45
project = u'OpenERP Server Developers Documentation'
46
copyright = u'2012, OpenERP s.a.'
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
52
# The short X.Y version.
54
# The full version, including alpha/beta/rc tags.
57
# The language for content autogenerated by Sphinx. Refer to documentation
58
# for a list of supported languages.
61
# There are two options for replacing |today|: either, you set today to some
62
# non-false value, then it is used:
64
# Else, today_fmt is used as the format for a strftime call.
65
#today_fmt = '%B %d, %Y'
67
# List of patterns, relative to source directory, that match files and
68
# directories to ignore when looking for source files.
69
exclude_patterns = ['_build']
71
# The reST default role (used for this markup: `text`) to use for all documents.
74
# If true, '()' will be appended to :func: etc. cross-reference text.
75
#add_function_parentheses = True
77
# If true, the current module name will be prepended to all description
78
# unit titles (such as .. function::).
79
#add_module_names = True
81
# If true, sectionauthor and moduleauthor directives will be shown in the
82
# output. They are ignored by default.
85
# The name of the Pygments (syntax highlighting) style to use.
86
pygments_style = 'sphinx'
88
# A list of ignored prefixes for module index sorting.
89
#modindex_common_prefix = []
92
# -- Options for HTML output ---------------------------------------------------
94
# The theme to use for HTML and HTML Help pages. See the documentation for
95
# a list of builtin themes.
98
# Theme options are theme-specific and customize the look and feel of a theme
99
# further. For a list of options available for each theme, see the
101
#html_theme_options = {}
103
# Add any paths that contain custom themes here, relative to this directory.
104
html_theme_path = ['_themes']
106
# The name for this set of Sphinx documents. If None, it defaults to
107
# "<project> v<release> documentation".
110
# A shorter title for the navigation bar. Default is the same as html_title.
111
#html_short_title = None
113
# The name of an image file (relative to this directory) to place at the top
117
# The name of an image file (within the static path) to use as favicon of the
118
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
122
# Add any paths that contain custom static files (such as style sheets) here,
123
# relative to this directory. They are copied after the builtin static files,
124
# so a file named "default.css" will overwrite the builtin "default.css".
125
html_static_path = ['_static']
127
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
128
# using the given strftime format.
129
#html_last_updated_fmt = '%b %d, %Y'
131
# If true, SmartyPants will be used to convert quotes and dashes to
132
# typographically correct entities.
133
#html_use_smartypants = True
135
# Custom sidebar templates, maps document names to template names.
137
'index': ['sidebarintro.html', 'sourcelink.html', 'searchbox.html'],
138
'**': ['sidebarlogo.html', 'localtoc.html', 'relations.html',
139
'sourcelink.html', 'searchbox.html']
142
# Additional templates that should be rendered to pages, maps page names to
144
#html_additional_pages = {}
146
# If false, no module index is generated.
147
#html_domain_indices = True
149
# If false, no index is generated.
150
#html_use_index = True
152
# If true, the index is split into individual pages for each letter.
153
#html_split_index = False
155
# If true, links to the reST sources are added to the pages.
156
#html_show_sourcelink = True
158
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
159
#html_show_sphinx = True
161
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
162
#html_show_copyright = True
164
# If true, an OpenSearch description file will be output, and all pages will
165
# contain a <link> tag referring to it. The value of this option must be the
166
# base URL from which the finished HTML is served.
167
#html_use_opensearch = ''
169
# This is the file name suffix for HTML files (e.g. ".xhtml").
170
#html_file_suffix = None
172
# Output file base name for HTML help builder.
173
htmlhelp_basename = 'openerp-server-doc'
176
# -- Options for LaTeX output --------------------------------------------------
179
# The paper size ('letterpaper' or 'a4paper').
180
#'papersize': 'letterpaper',
182
# The font size ('10pt', '11pt' or '12pt').
183
#'pointsize': '10pt',
185
# Additional stuff for the LaTeX preamble.
189
# Grouping the document tree into LaTeX files. List of tuples
190
# (source start file, target name, title, author, documentclass [howto/manual]).
192
('index', 'openerp-server-doc.tex', u'OpenERP Server Developers Documentation',
193
u'OpenERP s.a.', 'manual'),
196
# The name of an image file (relative to this directory) to place at the top of
200
# For "manual" documents, if this is true, then toplevel headings are parts,
202
#latex_use_parts = False
204
# If true, show page references after internal links.
205
#latex_show_pagerefs = False
207
# If true, show URL addresses after external links.
208
#latex_show_urls = False
210
# Documents to append as an appendix to all manuals.
211
#latex_appendices = []
213
# If false, no module index is generated.
214
#latex_domain_indices = True
217
# -- Options for manual page output --------------------------------------------
219
# One entry per manual page. List of tuples
220
# (source start file, name, description, authors, manual section).
222
('index', 'openerp-server-doc', u'OpenERP Server Developers Documentation',
223
[u'OpenERP s.a.'], 1)
226
# If true, show URL addresses after external links.
227
#man_show_urls = False
230
# -- Options for Texinfo output ------------------------------------------------
232
# Grouping the document tree into Texinfo files. List of tuples
233
# (source start file, target name, title, author,
234
# dir menu entry, description, category)
235
texinfo_documents = [
236
('index', 'OpenERPServerDocumentation', u'OpenERP Server Developers Documentation',
237
u'OpenERP s.a.', 'OpenERPServerDocumentation', 'Developers documentation for the openobject-server project.',
241
# Documents to append as an appendix to all manuals.
242
#texinfo_appendices = []
244
# If false, no module index is generated.
245
#texinfo_domain_indices = True
247
# How to display URL addresses: 'footnote', 'no', or 'inline'.
248
#texinfo_show_urls = 'footnote'
251
# Example configuration for intersphinx: refer to the Python standard library.
252
intersphinx_mapping = {
253
'python': ('http://docs.python.org/', None),
254
'openerpweb': ('http://doc.openerp.com/trunk/developers/web', None),
255
'openerpdev': ('http://doc.openerp.com/trunk/developers', None),
added
removed
doc/conf.py
