1 # -*- coding: utf-8 -*-

     2 # copyright 2003-2010 LOGILAB S.A. (Paris, FRANCE), all rights reserved.

     3 # contact http://www.logilab.fr/ -- mailto:contact@logilab.fr

     4 #

     5 # This file is part of CubicWeb.

     6 #

     7 # CubicWeb is free software: you can redistribute it and/or modify it under the

     8 # terms of the GNU Lesser General Public License as published by the Free

     9 # Software Foundation, either version 2.1 of the License, or (at your option)

    10 # any later version.

    11 #

    12 # CubicWeb is distributed in the hope that it will be useful, but WITHOUT

    13 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS

    14 # FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more

    15 # details.

    16 #

    17 # You should have received a copy of the GNU Lesser General Public License along

    18 # with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.

    19 """

    20 

    21 """

    22 #

    23 # Cubicweb documentation build configuration file, created by

    24 # sphinx-quickstart on Fri Oct 31 09:10:36 2008.

    25 #

    26 # This file is execfile()d with the current directory set to its containing dir.

    27 #

    28 # The contents of this file are pickled, so don't put values in the namespace

    29 # that aren't pickleable (module imports are okay, they're removed automatically).

    30 #

    31 # All configuration values have a default value; values that are commented out

    32 # serve to show the default value.

    33 

    34 import sys, os

    35 

    36 # If your extensions are in another directory, add it here. If the directory

    37 # is relative to the documentation root, use os.path.abspath to make it

    38 # absolute, like shown here.

    39 #sys.path.append(os.path.abspath('some/directory'))

    40 

    41 # General configuration

    42 # ---------------------

    43 

    44 # Add any Sphinx extension module names here, as strings. They can be extensions

    45 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.

    46 extensions = ['sphinx.ext.autodoc']

    47 autoclass_content = 'both'

    48 # Add any paths that contain templates here, relative to this directory.

    49 templates_path = ['.templates']

    50 

    51 # The suffix of source filenames.

    52 source_suffix = '.txt'

    53 

    54 # The master toctree document.

    55 master_doc = 'index'

    56 

    57 # General substitutions.

    58 project = 'Cubicweb'

    59 copyright = '2008-2010, Logilab'

    60 

    61 # The default replacements for |version| and |release|, also used in various

    62 # other places throughout the built documents.

    63 #

    64 # The short X.Y version.

    65 version = '0.54'

    66 # The full version, including alpha/beta/rc tags.

    67 release = '3.0'

    68 

    69 # There are two options for replacing |today|: either, you set today to some

    70 # non-false value, then it is used:

    71 #today = ''

    72 # Else, today_fmt is used as the format for a strftime call.

    73 today_fmt = '%B %d, %Y'

    74 

    75 # List of documents that shouldn't be included in the build.

    76 #unused_docs = []

    77 

    78 # List of directories, relative to source directories, that shouldn't be searched

    79 # for source files.

    80 #exclude_dirs = []

    81 

    82 # The reST default role (used for this markup: `text`) to use for all documents.

    83 #default_role = None

    84 

    85 # If true, '()' will be appended to :func: etc. cross-reference text.

    86 #add_function_parentheses = True

    87 

    88 # If true, the current module name will be prepended to all description

    89 # unit titles (such as .. function::).

    90 #add_module_names = True

    91 

    92 # If true, sectionauthor and moduleauthor directives will be shown in the

    93 # output. They are ignored by default.

    94 #show_authors = False

    95 

    96 # The name of the Pygments (syntax highlighting) style to use.

    97 pygments_style = 'sphinx'

    98 

    99 

   100 # Options for HTML output

   101 # -----------------------

   102 

   103 # The style sheet to use for HTML and HTML Help pages. A file of that name

   104 # must exist either in Sphinx' static/ path, or in one of the custom paths

   105 # given in html_static_path.

   106 html_style = 'sphinx-default.css'

   107 

   108 # The name for this set of Sphinx documents.  If None, it defaults to

   109 # "<project> v<release> documentation".

   110 html_title = '%s %s' % (project, release)

   111 

   112 # A shorter title for the navigation bar.  Default is the same as html_title.

   113 #html_short_title = None

   114 

   115 # The name of an image file (within the static path) to place at the top of

   116 # the sidebar.

   117 #html_logo = None

   118 

   119 # The name of an image file (within the static path) to use as favicon of the

   120 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32

   121 # pixels large.

   122 #html_favicon = None

   123 

   124 # Add any paths that contain custom static files (such as style sheets) here,

   125 # relative to this directory. They are copied after the builtin static files,

   126 # so a file named "default.css" will overwrite the builtin "default.css".

   127 html_static_path = ['.static']

   128 

   129 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,

   130 # using the given strftime format.

   131 html_last_updated_fmt = '%b %d, %Y'

   132 

   133 # If true, SmartyPants will be used to convert quotes and dashes to

   134 # typographically correct entities.

   135 #html_use_smartypants = True

   136 

   137 # Custom sidebar templates, maps document names to template names.

   138 #html_sidebars = {}

   139 

   140 # Additional templates that should be rendered to pages, maps page names to

   141 # template names.

   142 #html_additional_pages = {}

   143 

   144 # If false, no module index is generated.

   145 html_use_modindex = True

   146 

   147 # If false, no index is generated.

   148 #html_use_index = True

   149 

   150 # If true, the index is split into individual pages for each letter.

   151 #html_split_index = False

   152 

   153 # If true, the reST sources are included in the HTML build as _sources/<name>.

   154 #html_copy_source = True

   155 

   156 # If true, an OpenSearch description file will be output, and all pages will

   157 # contain a <link> tag referring to it.  The value of this option must be the

   158 # base URL from which the finished HTML is served.

   159 #html_use_opensearch = ''

   160 

   161 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").

   162 html_file_suffix = '.html'

   163 

   164 # Output file base name for HTML help builder.

   165 htmlhelp_basename = 'Cubicwebdoc'

   166 

   167 

   168 # Options for LaTeX output

   169 # ------------------------

   170 

   171 # The paper size ('letter' or 'a4').

   172 #latex_paper_size = 'letter'

   173 

   174 # The font size ('10pt', '11pt' or '12pt').

   175 #latex_font_size = '10pt'

   176 

   177 # Grouping the document tree into LaTeX files. List of tuples

   178 # (source start file, target name, title, author, document class [howto/manual]).

   179 latex_documents = [

   180   ('index', 'Cubicweb.tex', 'Cubicweb Documentation',

   181    'Logilab', 'manual'),

   182 ]

   183 

   184 # The name of an image file (relative to this directory) to place at the top of

   185 # the title page.

   186 #latex_logo = None

   187 

   188 # For "manual" documents, if this is true, then toplevel headings are parts,

   189 # not chapters.

   190 #latex_use_parts = False

   191 

   192 # Additional stuff for the LaTeX preamble.

   193 #latex_preamble = ''

   194 

   195 # Documents to append as an appendix to all manuals.

   196 #latex_appendices = []

   197 

   198 # If false, no module index is generated.

   199 #latex_use_modindex = True