1 # -*- coding: utf-8 -*-
3 # OpenERP Web documentation build configuration file, created by
4 # sphinx-quickstart on Fri Mar 18 16:31:55 2011.
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('../../addons'))
20 sys.path.insert(0, os.path.abspath('../..'))
22 # -- General configuration -----------------------------------------------------
24 # If your documentation needs a minimal Sphinx version, state it here.
27 # Add any Sphinx extension module names here, as strings. They can be extensions
28 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
29 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage' ]
31 # Add any paths that contain templates here, relative to this directory.
32 templates_path = ['_templates']
34 # The suffix of source filenames.
35 source_suffix = '.rst'
37 # The encoding of source files.
38 #source_encoding = 'utf-8-sig'
40 # The master toctree document.
43 # General information about the project.
44 project = u'OpenERP Web'
45 copyright = u'2011, OpenERP S.A.'
47 # The version info for the project you're documenting, acts as replacement for
48 # |version| and |release|, also used in various other places throughout the
51 # The short X.Y version.
53 # The full version, including alpha/beta/rc tags.
56 # The language for content autogenerated by Sphinx. Refer to documentation
57 # for a list of supported languages.
60 # There are two options for replacing |today|: either, you set today to some
61 # non-false value, then it is used:
63 # Else, today_fmt is used as the format for a strftime call.
64 #today_fmt = '%B %d, %Y'
66 # List of patterns, relative to source directory, that match files and
67 # directories to ignore when looking for source files.
70 # The reST default role (used for this markup: `text`) to use for all documents.
73 # If true, '()' will be appended to :func: etc. cross-reference text.
74 #add_function_parentheses = True
76 # If true, the current module name will be prepended to all description
77 # unit titles (such as .. function::).
78 #add_module_names = True
80 # If true, sectionauthor and moduleauthor directives will be shown in the
81 # output. They are ignored by default.
84 # The name of the Pygments (syntax highlighting) style to use.
85 pygments_style = 'sphinx'
87 # A list of ignored prefixes for module index sorting.
88 #modindex_common_prefix = []
91 # -- Options for HTML output ---------------------------------------------------
93 # The theme to use for HTML and HTML Help pages. See the documentation for
94 # a list of builtin themes.
95 html_theme = 'default'
97 # Theme options are theme-specific and customize the look and feel of a theme
98 # further. For a list of options available for each theme, see the
100 #html_theme_options = {}
102 # Add any paths that contain custom themes here, relative to this directory.
103 #html_theme_path = []
105 # The name for this set of Sphinx documents. If None, it defaults to
106 # "<project> v<release> documentation".
109 # A shorter title for the navigation bar. Default is the same as html_title.
110 #html_short_title = None
112 # The name of an image file (relative to this directory) to place at the top
116 # The name of an image file (within the static path) to use as favicon of the
117 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
121 # Add any paths that contain custom static files (such as style sheets) here,
122 # relative to this directory. They are copied after the builtin static files,
123 # so a file named "default.css" will overwrite the builtin "default.css".
124 html_static_path = ['_static']
126 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
127 # using the given strftime format.
128 #html_last_updated_fmt = '%b %d, %Y'
130 # If true, SmartyPants will be used to convert quotes and dashes to
131 # typographically correct entities.
132 #html_use_smartypants = True
134 # Custom sidebar templates, maps document names to template names.
137 # Additional templates that should be rendered to pages, maps page names to
139 #html_additional_pages = {}
141 # If false, no module index is generated.
142 #html_domain_indices = True
144 # If false, no index is generated.
145 #html_use_index = True
147 # If true, the index is split into individual pages for each letter.
148 #html_split_index = False
150 # If true, links to the reST sources are added to the pages.
151 #html_show_sourcelink = True
153 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
154 #html_show_sphinx = True
156 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
157 #html_show_copyright = True
159 # If true, an OpenSearch description file will be output, and all pages will
160 # contain a <link> tag referring to it. The value of this option must be the
161 # base URL from which the finished HTML is served.
162 #html_use_opensearch = ''
164 # This is the file name suffix for HTML files (e.g. ".xhtml").
165 #html_file_suffix = None
167 # Output file base name for HTML help builder.
168 htmlhelp_basename = 'OpenERPWebdoc'
171 # -- Options for LaTeX output --------------------------------------------------
173 # The paper size ('letter' or 'a4').
174 #latex_paper_size = 'letter'
176 # The font size ('10pt', '11pt' or '12pt').
177 #latex_font_size = '10pt'
179 # Grouping the document tree into LaTeX files. List of tuples
180 # (source start file, target name, title, author, documentclass [howto/manual]).
182 ('index', 'OpenERPWeb.tex', u'OpenERP Web Documentation',
183 u'OpenERP S.A.', 'manual'),
186 # The name of an image file (relative to this directory) to place at the top of
190 # For "manual" documents, if this is true, then toplevel headings are parts,
192 #latex_use_parts = False
194 # If true, show page references after internal links.
195 #latex_show_pagerefs = False
197 # If true, show URL addresses after external links.
198 #latex_show_urls = False
200 # Additional stuff for the LaTeX preamble.
203 # Documents to append as an appendix to all manuals.
204 #latex_appendices = []
206 # If false, no module index is generated.
207 #latex_domain_indices = True
210 # -- Options for manual page output --------------------------------------------
212 # One entry per manual page. List of tuples
213 # (source start file, name, description, authors, manual section).
215 ('index', 'openerpweb', u'OpenERP Web Documentation',
216 [u'OpenERP S.A.'], 1)
220 # -- Options for Epub output ---------------------------------------------------
222 # Bibliographic Dublin Core info.
223 epub_title = u'OpenERP Web'
224 epub_author = u'OpenERP S.A.'
225 epub_publisher = u'OpenERP S.A.'
226 epub_copyright = u'2011, OpenERP S.A.'
228 # The language of the text. It defaults to the language option
229 # or en if the language is not set.
232 # The scheme of the identifier. Typical schemes are ISBN or URL.
235 # The unique identifier of the text. This can be a ISBN number
236 # or the project homepage.
237 #epub_identifier = ''
239 # A unique identification for the text.
242 # HTML files that should be inserted before the pages created by sphinx.
243 # The format is a list of tuples containing the path and title.
246 # HTML files shat should be inserted after the pages created by sphinx.
247 # The format is a list of tuples containing the path and title.
248 #epub_post_files = []
250 # A list of files that should not be packed into the epub file.
251 #epub_exclude_files = []
253 # The depth of the table of contents in toc.ncx.
256 # Allow duplicate toc entries.