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

     2 # copyright 2003-2014 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 from os import path as osp

    35 

    36 path = __file__

    37 path = osp.dirname(path) #./doc/book/en

    38 path = osp.dirname(path) #./doc/book/

    39 path = osp.dirname(path) #./doc/

    40 path = osp.dirname(path) #./

    41 path = osp.join(path,'__pkginfo__.py') #./__pkginfo__.py

    42 cw = {}

    43 execfile(path,{},cw)

    44 

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

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

    47 # absolute, like shown here.

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

    49 

    50 # General configuration

    51 # ---------------------

    52 

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

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

    55 extensions = [

    56   'sphinx.ext.autodoc', 

    57   'sphinx.ext.viewcode',

    58   'logilab.common.sphinx_ext',

    59   ]

    60 

    61 autoclass_content = 'both'

    62 

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

    64 #templates_path = []

    65 

    66 # The suffix of source filenames.

    67 source_suffix = '.rst'

    68 

    69 # The master toctree document.

    70 master_doc = 'index'

    71 

    72 # General substitutions.

    73 project = 'CubicWeb'

    74 copyright = '2001-2014, Logilab'

    75 

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

    77 # other places throughout the built documents.

    78 #

    79 # The short X.Y version.

    80 version = '.'.join(str(n) for n in cw['numversion'][:2])

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

    82 release = cw['version']

    83 

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

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

    86 #today = ''

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

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

    89 

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

    91 unused_docs = []

    92 

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

    94 # for source files.

    95 #exclude_dirs = []

    96 

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

    98 #default_role = None

    99 

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

   101 #add_function_parentheses = True

   102 

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

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

   105 #add_module_names = True

   106 

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

   108 # output. They are ignored by default.

   109 #show_authors = False

   110 

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

   112 pygments_style = 'sphinx'

   113 

   114 

   115 # Options for HTML output

   116 # -----------------------

   117 

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

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

   120 # given in html_static_path.

   121 #html_style = 'sphinx-default.css'

   122 

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

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

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

   126 

   127 html_theme_path = ['_themes']

   128 html_theme = 'cubicweb'

   129 

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

   131 #html_short_title = None

   132 

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

   134 # the sidebar.

   135 #html_logo = None

   136 

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

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

   139 # pixels large.

   140 #html_favicon = None

   141 

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

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

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

   145 html_static_path = ['.static']

   146 

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

   148 # using the given strftime format.

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

   150 

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

   152 # typographically correct entities.

   153 #html_use_smartypants = True

   154 

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

   156 #html_sidebars = {}

   157 

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

   159 # template names.

   160 #html_additional_pages = {}

   161 

   162 # If false, no module index is generated.

   163 html_use_modindex = True

   164 

   165 # If false, no index is generated.

   166 #html_use_index = True

   167 

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

   169 #html_split_index = False

   170 

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

   172 #html_copy_source = True

   173 

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

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

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

   177 #html_use_opensearch = ''

   178 

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

   180 html_file_suffix = '.html'

   181 

   182 # Output file base name for HTML help builder.

   183 htmlhelp_basename = 'Cubicwebdoc'

   184 

   185 

   186 # Options for LaTeX output

   187 # ------------------------

   188 

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

   190 #latex_paper_size = 'letter'

   191 

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

   193 #latex_font_size = '10pt'

   194 

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

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

   197 latex_documents = [

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

   199    'Logilab', 'manual'),

   200 ]

   201 

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

   203 # the title page.

   204 #latex_logo = None

   205 

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

   207 # not chapters.

   208 #latex_use_parts = False

   209 

   210 # Additional stuff for the LaTeX preamble.

   211 #latex_preamble = ''

   212 

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

   214 #latex_appendices = []

   215 

   216 # If false, no module index is generated.

   217 #latex_use_modindex = True

   218 

   219 #aafig_format = dict(latex='pdf', html='svg', text=None)

   220 

   221 rst_epilog = """

   222 .. |cubicweb| replace:: *CubicWeb*

   223 .. |yams| replace:: *Yams*

   224 .. |rql| replace:: *RQL*

   225 """