1# -*- coding: utf-8 -*- 2# 3# OpenERP Technical Documentation configuration file, created by 4# sphinx-quickstart on Fri Feb 17 16:14:06 2012. 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('_themes')) 20sys.path.insert(0, os.path.abspath('../addons')) 21sys.path.insert(0, os.path.abspath('..')) 22 23# -- General configuration ----------------------------------------------------- 24 25# If your documentation needs a minimal Sphinx version, state it here. 26#needs_sphinx = '1.0' 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 = [ 31 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 32 'sphinx.ext.todo', 'sphinx.ext.viewcode', 33 'patchqueue' 34] 35 36# Add any paths that contain templates here, relative to this directory. 37templates_path = ['_templates'] 38 39# The suffix of source filenames. 40source_suffix = '.rst' 41 42# The encoding of source files. 43#source_encoding = 'utf-8-sig' 44 45# The master toctree document. 46master_doc = 'index' 47 48# General information about the project. 49project = u'OpenERP Web Developers Documentation' 50copyright = u'2012, OpenERP s.a.' 51 52# The version info for the project you're documenting, acts as replacement for 53# |version| and |release|, also used in various other places throughout the 54# built documents. 55# 56# The short X.Y version. 57version = '7.0' 58# The full version, including alpha/beta/rc tags. 59release = '7.0' 60 61# The language for content autogenerated by Sphinx. Refer to documentation 62# for a list of supported languages. 63#language = None 64 65# There are two options for replacing |today|: either, you set today to some 66# non-false value, then it is used: 67#today = '' 68# Else, today_fmt is used as the format for a strftime call. 69#today_fmt = '%B %d, %Y' 70 71# List of patterns, relative to source directory, that match files and 72# directories to ignore when looking for source files. 73exclude_patterns = ['_build'] 74 75# The reST default role (used for this markup: `text`) to use for all documents. 76#default_role = None 77 78# If true, '()' will be appended to :func: etc. cross-reference text. 79#add_function_parentheses = True 80 81# If true, the current module name will be prepended to all description 82# unit titles (such as .. function::). 83#add_module_names = True 84 85# If true, sectionauthor and moduleauthor directives will be shown in the 86# output. They are ignored by default. 87#show_authors = False 88 89# The name of the Pygments (syntax highlighting) style to use. 90pygments_style = 'sphinx' 91 92# A list of ignored prefixes for module index sorting. 93#modindex_common_prefix = [] 94 95 96# -- Options for HTML output --------------------------------------------------- 97 98# The theme to use for HTML and HTML Help pages. See the documentation for 99# a list of builtin themes. 100html_theme = 'flask' 101 102# Theme options are theme-specific and customize the look and feel of a theme 103# further. For a list of options available for each theme, see the 104# documentation. 105#html_theme_options = {} 106 107# Add any paths that contain custom themes here, relative to this directory. 108html_theme_path = ['_themes'] 109 110# The name for this set of Sphinx documents. If None, it defaults to 111# "<project> v<release> documentation". 112#html_title = None 113 114# A shorter title for the navigation bar. Default is the same as html_title. 115#html_short_title = None 116 117# The name of an image file (relative to this directory) to place at the top 118# of the sidebar. 119#html_logo = None 120 121# The name of an image file (within the static path) to use as favicon of the 122# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 123# pixels large. 124#html_favicon = None 125 126# Add any paths that contain custom static files (such as style sheets) here, 127# relative to this directory. They are copied after the builtin static files, 128# so a file named "default.css" will overwrite the builtin "default.css". 129html_static_path = ['_static'] 130 131# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 132# using the given strftime format. 133#html_last_updated_fmt = '%b %d, %Y' 134 135# If true, SmartyPants will be used to convert quotes and dashes to 136# typographically correct entities. 137#html_use_smartypants = True 138 139# Custom sidebar templates, maps document names to template names. 140html_sidebars = { 141 'index': ['sidebarintro.html', 'sourcelink.html', 'searchbox.html'], 142 '**': ['sidebarlogo.html', 'localtoc.html', 'relations.html', 143 'sourcelink.html', 'searchbox.html'] 144} 145 146# Additional templates that should be rendered to pages, maps page names to 147# template names. 148#html_additional_pages = {} 149 150# If false, no module index is generated. 151#html_domain_indices = True 152 153# If false, no index is generated. 154#html_use_index = True 155 156# If true, the index is split into individual pages for each letter. 157#html_split_index = False 158 159# If true, links to the reST sources are added to the pages. 160#html_show_sourcelink = True 161 162# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 163#html_show_sphinx = True 164 165# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 166#html_show_copyright = True 167 168# If true, an OpenSearch description file will be output, and all pages will 169# contain a <link> tag referring to it. The value of this option must be the 170# base URL from which the finished HTML is served. 171#html_use_opensearch = '' 172 173# This is the file name suffix for HTML files (e.g. ".xhtml"). 174#html_file_suffix = None 175 176# Output file base name for HTML help builder. 177htmlhelp_basename = 'openerp-web-doc' 178 179 180# -- Options for LaTeX output -------------------------------------------------- 181 182latex_elements = { 183# The paper size ('letterpaper' or 'a4paper'). 184#'papersize': 'letterpaper', 185 186# The font size ('10pt', '11pt' or '12pt'). 187#'pointsize': '10pt', 188 189# Additional stuff for the LaTeX preamble. 190#'preamble': '', 191} 192 193# Grouping the document tree into LaTeX files. List of tuples 194# (source start file, target name, title, author, documentclass [howto/manual]). 195latex_documents = [ 196 ('index', 'openerp-web-doc.tex', u'OpenERP Web Developers Documentation', 197 u'OpenERP s.a.', 'manual'), 198] 199 200# The name of an image file (relative to this directory) to place at the top of 201# the title page. 202#latex_logo = None 203 204# For "manual" documents, if this is true, then toplevel headings are parts, 205# not chapters. 206#latex_use_parts = False 207 208# If true, show page references after internal links. 209#latex_show_pagerefs = False 210 211# If true, show URL addresses after external links. 212#latex_show_urls = False 213 214# Documents to append as an appendix to all manuals. 215#latex_appendices = [] 216 217# If false, no module index is generated. 218#latex_domain_indices = True 219 220 221# -- Options for manual page output -------------------------------------------- 222 223# One entry per manual page. List of tuples 224# (source start file, name, description, authors, manual section). 225man_pages = [ 226 ('index', 'openerp-web-doc', u'OpenERP Web Developers Documentation', 227 [u'OpenERP s.a.'], 1) 228] 229 230# If true, show URL addresses after external links. 231#man_show_urls = False 232 233 234# -- Options for Texinfo output ------------------------------------------------ 235 236# Grouping the document tree into Texinfo files. List of tuples 237# (source start file, target name, title, author, 238# dir menu entry, description, category) 239texinfo_documents = [ 240 ('index', 'OpenERPWebDocumentation', u'OpenERP Web Developers Documentation', 241 u'OpenERP s.a.', 'OpenERPWebDocumentation', 'Developers documentation for the openerp-web project.', 242 'Miscellaneous'), 243] 244 245# Documents to append as an appendix to all manuals. 246#texinfo_appendices = [] 247 248# If false, no module index is generated. 249#texinfo_domain_indices = True 250 251# How to display URL addresses: 'footnote', 'no', or 'inline'. 252#texinfo_show_urls = 'footnote' 253 254todo_include_todos = True 255 256# Example configuration for intersphinx: refer to the Python standard library. 257intersphinx_mapping = { 258 'python': ('http://docs.python.org/', None), 259 'openerpserver': ('http://doc.openerp.com/trunk/developers/server', None), 260} 261