diff options
| author | Vo Minh Thu <vmt@openerp.com> | 2012-03-05 09:49:40 +0100 |
|---|---|---|
| committer | Vo Minh Thu <vmt@openerp.com> | 2012-03-05 09:49:40 +0100 |
| commit | 2b8d20f424a153da410d7bd4ba6ba4ff27db9d84 (patch) | |
| tree | ef87008992ab516df5f8bb61b5d3daacaee34d51 /doc/source/conf.py | |
| parent | e178185b4fc600f8a612f3ef6027ebb85acef516 (diff) | |
[DOC] Added modified (used in global doc and server) flask theme.
bzr revid: vmt@openerp.com-20120305084940-wxz0haidk99fh77s
Diffstat (limited to 'doc/source/conf.py')
| -rw-r--r-- | doc/source/conf.py | 101 |
1 files changed, 49 insertions, 52 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 13a490c5072..c57c3629317 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- # -# OpenERP Web documentation build configuration file, created by -# sphinx-quickstart on Fri Mar 18 16:31:55 2011. +# OpenERP Technical Documentation configuration file, created by +# sphinx-quickstart on Fri Feb 17 16:14:06 2012. # # This file is execfile()d with the current directory set to its containing dir. # @@ -16,6 +16,7 @@ import sys, os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.append(os.path.abspath('_themes')) sys.path.insert(0, os.path.abspath('../../addons')) sys.path.insert(0, os.path.abspath('../..')) @@ -26,7 +27,7 @@ sys.path.insert(0, os.path.abspath('../..')) # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage' ] +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.viewcode'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -41,8 +42,8 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'OpenERP Web' -copyright = u'2011, OpenERP S.A.' +project = u'OpenERP Server Developers Documentation' +copyright = u'2012, OpenERP s.a.' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -51,7 +52,7 @@ copyright = u'2011, OpenERP S.A.' # The short X.Y version. version = '6.1' # The full version, including alpha/beta/rc tags. -release = '6.1.0pre' +release = '6.1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -65,7 +66,7 @@ release = '6.1.0pre' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = [] +exclude_patterns = ['_build'] # The reST default role (used for this markup: `text`) to use for all documents. #default_role = None @@ -92,7 +93,7 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = 'flask' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -100,7 +101,7 @@ html_theme = 'default' #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +html_theme_path = ['_themes'] # The name for this set of Sphinx documents. If None, it defaults to # "<project> v<release> documentation". @@ -132,7 +133,11 @@ html_static_path = ['_static'] #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +html_sidebars = { + 'index': ['sidebarintro.html', 'sourcelink.html', 'searchbox.html'], + '**': ['sidebarlogo.html', 'localtoc.html', 'relations.html', + 'sourcelink.html', 'searchbox.html'] +} # Additional templates that should be rendered to pages, maps page names to # template names. @@ -165,22 +170,27 @@ html_static_path = ['_static'] #html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'OpenERPWebdoc' +htmlhelp_basename = 'openerp-server-doc' # -- Options for LaTeX output -------------------------------------------------- -# The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'OpenERPWeb.tex', u'OpenERP Web Documentation', - u'OpenERP S.A.', 'manual'), + ('index', 'openerp-server-doc.tex', u'OpenERP Server Developers Documentation', + u'OpenERP s.a.', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -197,9 +207,6 @@ latex_documents = [ # If true, show URL addresses after external links. #latex_show_urls = False -# Additional stuff for the LaTeX preamble. -#latex_preamble = '' - # Documents to append as an appendix to all manuals. #latex_appendices = [] @@ -212,46 +219,36 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'openerpweb', u'OpenERP Web Documentation', - [u'OpenERP S.A.'], 1) + ('index', 'openerp-server-doc', u'OpenERP Server Developers Documentation', + [u'OpenERP s.a.'], 1) ] +# If true, show URL addresses after external links. +#man_show_urls = False -# -- Options for Epub output --------------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = u'OpenERP Web' -epub_author = u'OpenERP S.A.' -epub_publisher = u'OpenERP S.A.' -epub_copyright = u'2011, OpenERP S.A.' - -# The language of the text. It defaults to the language option -# or en if the language is not set. -#epub_language = '' - -# The scheme of the identifier. Typical schemes are ISBN or URL. -#epub_scheme = '' -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -#epub_identifier = '' +# -- Options for Texinfo output ------------------------------------------------ -# A unique identification for the text. -#epub_uid = '' +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'OpenERPServerDocumentation', u'OpenERP Server Developers Documentation', + u'OpenERP s.a.', 'OpenERPServerDocumentation', 'Developers documentation for the openobject-server project.', + 'Miscellaneous'), +] -# HTML files that should be inserted before the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_pre_files = [] +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] -# HTML files shat should be inserted after the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_post_files = [] +# If false, no module index is generated. +#texinfo_domain_indices = True -# A list of files that should not be packed into the epub file. -#epub_exclude_files = [] +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' -# The depth of the table of contents in toc.ncx. -#epub_tocdepth = 3 -# Allow duplicate toc entries. -#epub_tocdup = True +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + 'http://docs.python.org/': None, + } |
