author | Denis Laxalde <denis.laxalde@logilab.fr> |
Tue, 06 Aug 2019 15:43:59 +0200 | |
branch | 3.26 |
changeset 12720 | 172f683a84f6 |
parent 12352 | 1a0159426def |
child 12791 | 4564ecfc0134 |
permissions | -rw-r--r-- |
10491
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
1 |
# -*- coding: utf-8 -*- |
10496
e95b559a06a2
[doc] more fixes of warnings/errors in doc build
David Douard <david.douard@logilab.fr>
parents:
10494
diff
changeset
|
2 |
# copyright 2003-2015 LOGILAB S.A. (Paris, FRANCE), all rights reserved. |
10491
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
3 |
# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
4 |
# |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
5 |
# This file is part of CubicWeb. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
6 |
# |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
7 |
# CubicWeb is free software: you can redistribute it and/or modify it under the |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
8 |
# terms of the GNU Lesser General Public License as published by the Free |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
9 |
# Software Foundation, either version 2.1 of the License, or (at your option) |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
10 |
# any later version. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
11 |
# |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
12 |
# CubicWeb is distributed in the hope that it will be useful, but WITHOUT |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
13 |
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
14 |
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
15 |
# details. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
16 |
# |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
17 |
# You should have received a copy of the GNU Lesser General Public License along |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
18 |
# with CubicWeb. If not, see <http://www.gnu.org/licenses/>. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
19 |
""" |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
20 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
21 |
""" |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
22 |
# |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
23 |
# Cubicweb documentation build configuration file, created by |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
24 |
# sphinx-quickstart on Fri Oct 31 09:10:36 2008. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
25 |
# |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
26 |
# This file is execfile()d with the current directory set to its containing dir. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
27 |
# |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
28 |
# The contents of this file are pickled, so don't put values in the namespace |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
29 |
# that aren't pickleable (module imports are okay, they're removed automatically). |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
30 |
# |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
31 |
# All configuration values have a default value; values that are commented out |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
32 |
# serve to show the default value. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
33 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
34 |
from os import path as osp |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
35 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
36 |
path = __file__ |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
37 |
path = osp.dirname(path) # ./doc |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
38 |
path = osp.dirname(path) # ./ |
11057
0b59724cb3f2
Reorganize source tree to have a "cubicweb" top-level package
Denis Laxalde <denis.laxalde@logilab.fr>
parents:
10496
diff
changeset
|
39 |
path = osp.join(path, 'cubicweb', '__pkginfo__.py') # ./__pkginfo__.py |
10491
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
40 |
cw = {} |
11057
0b59724cb3f2
Reorganize source tree to have a "cubicweb" top-level package
Denis Laxalde <denis.laxalde@logilab.fr>
parents:
10496
diff
changeset
|
41 |
with open(path) as f: |
0b59724cb3f2
Reorganize source tree to have a "cubicweb" top-level package
Denis Laxalde <denis.laxalde@logilab.fr>
parents:
10496
diff
changeset
|
42 |
exec(f.read(), cw) |
10491
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
43 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
44 |
# If your extensions are in another directory, add it here. If the directory |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
45 |
# is relative to the documentation root, use os.path.abspath to make it |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
46 |
# absolute, like shown here. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
47 |
#sys.path.append(os.path.abspath('some/directory')) |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
48 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
49 |
# General configuration |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
50 |
# --------------------- |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
51 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
52 |
# Add any Sphinx extension module names here, as strings. They can be extensions |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
53 |
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
54 |
extensions = [ |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
55 |
'sphinx.ext.autodoc', |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
56 |
'sphinx.ext.viewcode', |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
57 |
] |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
58 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
59 |
autoclass_content = 'both' |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
60 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
61 |
# Add any paths that contain templates here, relative to this directory. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
62 |
#templates_path = [] |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
63 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
64 |
# The suffix of source filenames. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
65 |
source_suffix = '.rst' |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
66 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
67 |
# The master toctree document. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
68 |
master_doc = 'index' |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
69 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
70 |
# General substitutions. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
71 |
project = 'CubicWeb' |
10496
e95b559a06a2
[doc] more fixes of warnings/errors in doc build
David Douard <david.douard@logilab.fr>
parents:
10494
diff
changeset
|
72 |
copyright = '2001-2015, Logilab' |
10491
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
73 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
74 |
# The default replacements for |version| and |release|, also used in various |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
75 |
# other places throughout the built documents. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
76 |
# |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
77 |
# The short X.Y version. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
78 |
version = '.'.join(str(n) for n in cw['numversion'][:2]) |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
79 |
# The full version, including alpha/beta/rc tags. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
80 |
release = cw['version'] |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
81 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
82 |
# There are two options for replacing |today|: either, you set today to some |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
83 |
# non-false value, then it is used: |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
84 |
#today = '' |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
85 |
# Else, today_fmt is used as the format for a strftime call. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
86 |
today_fmt = '%B %d, %Y' |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
87 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
88 |
# List of documents that shouldn't be included in the build. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
89 |
unused_docs = [] |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
90 |
|
10496
e95b559a06a2
[doc] more fixes of warnings/errors in doc build
David Douard <david.douard@logilab.fr>
parents:
10494
diff
changeset
|
91 |
# A list of glob-style patterns that should be excluded when looking |
e95b559a06a2
[doc] more fixes of warnings/errors in doc build
David Douard <david.douard@logilab.fr>
parents:
10494
diff
changeset
|
92 |
# for source files. [1] They are matched against the source file names |
e95b559a06a2
[doc] more fixes of warnings/errors in doc build
David Douard <david.douard@logilab.fr>
parents:
10494
diff
changeset
|
93 |
# relative to the source directory, using slashes as directory |
e95b559a06a2
[doc] more fixes of warnings/errors in doc build
David Douard <david.douard@logilab.fr>
parents:
10494
diff
changeset
|
94 |
# separators on all platforms. |
e95b559a06a2
[doc] more fixes of warnings/errors in doc build
David Douard <david.douard@logilab.fr>
parents:
10494
diff
changeset
|
95 |
exclude_patterns = ['book/_maybe_to_integrate'] |
10491
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
96 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
97 |
# The reST default role (used for this markup: `text`) to use for all documents. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
98 |
#default_role = None |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
99 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
100 |
# If true, '()' will be appended to :func: etc. cross-reference text. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
101 |
#add_function_parentheses = True |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
102 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
103 |
# If true, the current module name will be prepended to all description |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
104 |
# unit titles (such as .. function::). |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
105 |
#add_module_names = True |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
106 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
107 |
# If true, sectionauthor and moduleauthor directives will be shown in the |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
108 |
# output. They are ignored by default. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
109 |
#show_authors = False |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
110 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
111 |
# The name of the Pygments (syntax highlighting) style to use. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
112 |
pygments_style = 'sphinx' |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
113 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
114 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
115 |
# Options for HTML output |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
116 |
# ----------------------- |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
117 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
118 |
# The style sheet to use for HTML and HTML Help pages. A file of that name |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
119 |
# must exist either in Sphinx' static/ path, or in one of the custom paths |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
120 |
# given in html_static_path. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
121 |
#html_style = 'sphinx-default.css' |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
122 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
123 |
# The name for this set of Sphinx documents. If None, it defaults to |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
124 |
# "<project> v<release> documentation". |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
125 |
html_title = '%s %s' % (project, release) |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
126 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
127 |
html_theme_path = ['_themes'] |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
128 |
html_theme = 'cubicweb' |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
129 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
130 |
# A shorter title for the navigation bar. Default is the same as html_title. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
131 |
#html_short_title = None |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
132 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
133 |
# The name of an image file (within the static path) to place at the top of |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
134 |
# the sidebar. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
135 |
#html_logo = None |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
136 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
137 |
# The name of an image file (within the static path) to use as favicon of the |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
138 |
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
139 |
# pixels large. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
140 |
#html_favicon = None |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
141 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
142 |
# Add any paths that contain custom static files (such as style sheets) here, |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
143 |
# relative to this directory. They are copied after the builtin static files, |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
144 |
# so a file named "default.css" will overwrite the builtin "default.css". |
10494
b6f00889355c
[doc] Start documenting the API
Christophe de Vienne <christophe@unlish.com>
parents:
10491
diff
changeset
|
145 |
html_static_path = ['_static'] |
10491
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
146 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
147 |
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
148 |
# using the given strftime format. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
149 |
html_last_updated_fmt = '%b %d, %Y' |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
150 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
151 |
# If true, SmartyPants will be used to convert quotes and dashes to |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
152 |
# typographically correct entities. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
153 |
#html_use_smartypants = True |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
154 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
155 |
# Custom sidebar templates, maps document names to template names. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
156 |
#html_sidebars = {} |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
157 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
158 |
# Additional templates that should be rendered to pages, maps page names to |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
159 |
# template names. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
160 |
#html_additional_pages = {} |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
161 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
162 |
# If false, no module index is generated. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
163 |
html_use_modindex = True |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
164 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
165 |
# If false, no index is generated. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
166 |
#html_use_index = True |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
167 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
168 |
# If true, the index is split into individual pages for each letter. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
169 |
#html_split_index = False |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
170 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
171 |
# If true, the reST sources are included in the HTML build as _sources/<name>. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
172 |
#html_copy_source = True |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
173 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
174 |
# If true, an OpenSearch description file will be output, and all pages will |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
175 |
# contain a <link> tag referring to it. The value of this option must be the |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
176 |
# base URL from which the finished HTML is served. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
177 |
#html_use_opensearch = '' |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
178 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
179 |
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
180 |
html_file_suffix = '.html' |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
181 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
182 |
# Output file base name for HTML help builder. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
183 |
htmlhelp_basename = 'Cubicwebdoc' |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
184 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
185 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
186 |
# Options for LaTeX output |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
187 |
# ------------------------ |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
188 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
189 |
# The paper size ('letter' or 'a4'). |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
190 |
#latex_paper_size = 'letter' |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
191 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
192 |
# The font size ('10pt', '11pt' or '12pt'). |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
193 |
#latex_font_size = '10pt' |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
194 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
195 |
# Grouping the document tree into LaTeX files. List of tuples |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
196 |
# (source start file, target name, title, author, document class [howto/manual]). |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
197 |
latex_documents = [ |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
198 |
('index', 'Cubicweb.tex', 'Cubicweb Documentation', |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
199 |
'Logilab', 'manual'), |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
200 |
] |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
201 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
202 |
# The name of an image file (relative to this directory) to place at the top of |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
203 |
# the title page. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
204 |
#latex_logo = None |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
205 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
206 |
# For "manual" documents, if this is true, then toplevel headings are parts, |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
207 |
# not chapters. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
208 |
#latex_use_parts = False |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
209 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
210 |
# Additional stuff for the LaTeX preamble. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
211 |
#latex_preamble = '' |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
212 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
213 |
# Documents to append as an appendix to all manuals. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
214 |
#latex_appendices = [] |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
215 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
216 |
# If false, no module index is generated. |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
217 |
#latex_use_modindex = True |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
218 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
219 |
#aafig_format = dict(latex='pdf', html='svg', text=None) |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
220 |
|
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
221 |
rst_epilog = """ |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
222 |
.. |cubicweb| replace:: *CubicWeb* |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
223 |
.. |yams| replace:: *Yams* |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
224 |
.. |rql| replace:: *RQL* |
c67bcee93248
[doc] Restructure the documentation
Christophe de Vienne <christophe@unlish.com>
parents:
diff
changeset
|
225 |
""" |
11631
faf279e33298
Merge with pyramid-cubicweb
Yann Voté <yann.vote@logilab.fr>
parents:
11057
diff
changeset
|
226 |
|
faf279e33298
Merge with pyramid-cubicweb
Yann Voté <yann.vote@logilab.fr>
parents:
11057
diff
changeset
|
227 |
def setup(app): |
faf279e33298
Merge with pyramid-cubicweb
Yann Voté <yann.vote@logilab.fr>
parents:
11057
diff
changeset
|
228 |
app.add_object_type('confval', 'confval', |
faf279e33298
Merge with pyramid-cubicweb
Yann Voté <yann.vote@logilab.fr>
parents:
11057
diff
changeset
|
229 |
objname='configuration value', |
faf279e33298
Merge with pyramid-cubicweb
Yann Voté <yann.vote@logilab.fr>
parents:
11057
diff
changeset
|
230 |
indextemplate='pair: %s; configuration value') |