doc/conf.py

   1 # -*- coding: utf-8 -*-
   2 import sys, os
   3
   4 # If extensions (or modules to document with autodoc) are in another directory,
   5 # add these directories to sys.path here. If the directory is relative to the
   6 # documentation root, use os.path.abspath to make it absolute, like shown here.
   7 DIR = os.path.dirname(__file__)
   8 sys.path.append(
   9     os.path.abspath(
  10         os.path.join(DIR, '_themes')))
  11 # autodoc
  12 sys.path.append(os.path.abspath(os.path.join(DIR, '..')))
  13
  14 # -- General configuration -----------------------------------------------------
  15
  16 # If your documentation needs a minimal Sphinx version, state it here.
  17 needs_sphinx = '1.1'
  18
  19 # Add any Sphinx extension module names here, as strings. They can be extensions
  20 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  21 extensions = ['sphinx.ext.todo', 'sphinx.ext.autodoc', 'odoodoc', 'patchqueue']
  22
  23 # Add any paths that contain templates here, relative to this directory.
  24 templates_path = ['_templates']
  25
  26 # The suffix of source filenames.
  27 source_suffix = '.rst'
  28
  29 # The encoding of source files.
  30 #source_encoding = 'utf-8-sig'
  31
  32 # The master toctree document.
  33 master_doc = 'index'
  34
  35 # General information about the project.
  36 project = u'odoo developer documentation'
  37 copyright = u'2014, OpenERP s.a.'
  38
  39 # The version info for the project you're documenting, acts as replacement for
  40 # |version| and |release|, also used in various other places throughout the
  41 # built documents.
  42 #
  43 # The short X.Y version.
  44 version = '8.0'
  45 # The full version, including alpha/beta/rc tags.
  46 release = '8.0b1'
  47
  48 # There are two options for replacing |today|: either, you set today to some
  49 # non-false value, then it is used:
  50 #today = ''
  51 # Else, today_fmt is used as the format for a strftime call.
  52 today_fmt = '%B %d, %Y'
  53
  54 # List of patterns, relative to source directory, that match files and
  55 # directories to ignore when looking for source files.
  56 exclude_patterns = ['_build']
  57
  58 # The reST default role (used for this markup: `text`) to use for all documents.
  59 #default_role = None
  60
  61 # If true, '()' will be appended to :func: etc. cross-reference text.
  62 add_function_parentheses = True
  63
  64 # If true, the current module name will be prepended to all description
  65 # unit titles (such as .. function::).
  66 #add_module_names = True
  67
  68 # If true, sectionauthor and moduleauthor directives will be shown in the
  69 # output. They are ignored by default.
  70 #show_authors = False
  71
  72 # The name of the Pygments (syntax highlighting) style to use.
  73 pygments_style = 'odoo'
  74
  75 # A list of ignored prefixes for module index sorting.
  76 #modindex_common_prefix = []
  77
  78
  79 # -- Options for HTML output ---------------------------------------------------
  80 # The theme to use for HTML and HTML Help pages.  See the documentation for
  81 # a list of builtin themes.
  82 html_theme = 'odoodoc'
  83
  84 # Theme options are theme-specific and customize the look and feel of a theme
  85 # further.  For a list of options available for each theme, see the
  86 # documentation.
  87 #html_theme_options = {}
  88
  89 # Add any paths that contain custom themes here, relative to this directory.
  90 html_theme_path = ['_themes']
  91
  92 # The name for this set of Sphinx documents.  If None, it defaults to
  93 # "<project> v<release> documentation".
  94 #html_title = None
  95
  96 # A shorter title for the navigation bar.  Default is the same as html_title.
  97 #html_short_title = None
  98
  99 # The name of an image file (relative to this directory) to place at the top
 100 # of the sidebar.
 101 #html_logo = None
 102
 103 # The name of an image file (within the static path) to use as favicon of the
 104 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 105 # pixels large.
 106 #html_favicon = None
 107
 108 # Add any paths that contain custom static files (such as style sheets) here,
 109 # relative to this directory. They are copied after the builtin static files,
 110 # so a file named "default.css" will overwrite the builtin "default.css".
 111 html_static_path = ['_static']
 112
 113 html_style = "odoo.css"
 114
 115 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 116 # using the given strftime format.
 117 #html_last_updated_fmt = '%b %d, %Y'
 118
 119 # If true, SmartyPants will be used to convert quotes and dashes to
 120 # typographically correct entities.
 121 #html_use_smartypants = True
 122
 123 # Custom sidebar templates, maps document names to template names.
 124 # FIXME: no sidebar on index?
 125 html_sidebars = {
 126 }
 127
 128 # Additional templates that should be rendered to pages, maps page names to
 129 # template names.
 130 #html_additional_pages = {}
 131
 132 # If false, no module index is generated.
 133 #html_domain_indices = True
 134
 135 # If false, no index is generated.
 136 #html_use_index = True
 137
 138 # If true, the index is split into individual pages for each letter.
 139 #html_split_index = False
 140
 141 # If true, links to the reST sources are added to the pages.
 142 #html_show_sourcelink = True
 143
 144 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 145 #html_show_sphinx = True
 146
 147 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
 148 #html_show_copyright = True
 149
 150 # If true, an OpenSearch description file will be output, and all pages will
 151 # contain a <link> tag referring to it.  The value of this option must be the
 152 # base URL from which the finished HTML is served.
 153 #html_use_opensearch = ''
 154