|
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 |
|
38 path = osp.dirname(path) # ./ |
|
39 path = osp.join(path, '__pkginfo__.py') # ./__pkginfo__.py |
|
40 cw = {} |
|
41 execfile(path, {}, cw) |
|
42 |
|
43 # If your extensions are in another directory, add it here. If the directory |
|
44 # is relative to the documentation root, use os.path.abspath to make it |
|
45 # absolute, like shown here. |
|
46 #sys.path.append(os.path.abspath('some/directory')) |
|
47 |
|
48 # General configuration |
|
49 # --------------------- |
|
50 |
|
51 # Add any Sphinx extension module names here, as strings. They can be extensions |
|
52 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
|
53 extensions = [ |
|
54 'sphinx.ext.autodoc', |
|
55 'sphinx.ext.viewcode', |
|
56 'logilab.common.sphinx_ext', |
|
57 ] |
|
58 |
|
59 autoclass_content = 'both' |
|
60 |
|
61 # Add any paths that contain templates here, relative to this directory. |
|
62 #templates_path = [] |
|
63 |
|
64 # The suffix of source filenames. |
|
65 source_suffix = '.rst' |
|
66 |
|
67 # The master toctree document. |
|
68 master_doc = 'index' |
|
69 |
|
70 # General substitutions. |
|
71 project = 'CubicWeb' |
|
72 copyright = '2001-2014, Logilab' |
|
73 |
|
74 # The default replacements for |version| and |release|, also used in various |
|
75 # other places throughout the built documents. |
|
76 # |
|
77 # The short X.Y version. |
|
78 version = '.'.join(str(n) for n in cw['numversion'][:2]) |
|
79 # The full version, including alpha/beta/rc tags. |
|
80 release = cw['version'] |
|
81 |
|
82 # There are two options for replacing |today|: either, you set today to some |
|
83 # non-false value, then it is used: |
|
84 #today = '' |
|
85 # Else, today_fmt is used as the format for a strftime call. |
|
86 today_fmt = '%B %d, %Y' |
|
87 |
|
88 # List of documents that shouldn't be included in the build. |
|
89 unused_docs = [] |
|
90 |
|
91 # List of directories, relative to source directories, that shouldn't be searched |
|
92 # for source files. |
|
93 #exclude_dirs = [] |
|
94 |
|
95 # The reST default role (used for this markup: `text`) to use for all documents. |
|
96 #default_role = None |
|
97 |
|
98 # If true, '()' will be appended to :func: etc. cross-reference text. |
|
99 #add_function_parentheses = True |
|
100 |
|
101 # If true, the current module name will be prepended to all description |
|
102 # unit titles (such as .. function::). |
|
103 #add_module_names = True |
|
104 |
|
105 # If true, sectionauthor and moduleauthor directives will be shown in the |
|
106 # output. They are ignored by default. |
|
107 #show_authors = False |
|
108 |
|
109 # The name of the Pygments (syntax highlighting) style to use. |
|
110 pygments_style = 'sphinx' |
|
111 |
|
112 |
|
113 # Options for HTML output |
|
114 # ----------------------- |
|
115 |
|
116 # The style sheet to use for HTML and HTML Help pages. A file of that name |
|
117 # must exist either in Sphinx' static/ path, or in one of the custom paths |
|
118 # given in html_static_path. |
|
119 #html_style = 'sphinx-default.css' |
|
120 |
|
121 # The name for this set of Sphinx documents. If None, it defaults to |
|
122 # "<project> v<release> documentation". |
|
123 html_title = '%s %s' % (project, release) |
|
124 |
|
125 html_theme_path = ['_themes'] |
|
126 html_theme = 'cubicweb' |
|
127 |
|
128 # A shorter title for the navigation bar. Default is the same as html_title. |
|
129 #html_short_title = None |
|
130 |
|
131 # The name of an image file (within the static path) to place at the top of |
|
132 # the sidebar. |
|
133 #html_logo = None |
|
134 |
|
135 # The name of an image file (within the static path) to use as favicon of the |
|
136 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
|
137 # pixels large. |
|
138 #html_favicon = None |
|
139 |
|
140 # Add any paths that contain custom static files (such as style sheets) here, |
|
141 # relative to this directory. They are copied after the builtin static files, |
|
142 # so a file named "default.css" will overwrite the builtin "default.css". |
|
143 html_static_path = ['.static'] |
|
144 |
|
145 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
|
146 # using the given strftime format. |
|
147 html_last_updated_fmt = '%b %d, %Y' |
|
148 |
|
149 # If true, SmartyPants will be used to convert quotes and dashes to |
|
150 # typographically correct entities. |
|
151 #html_use_smartypants = True |
|
152 |
|
153 # Custom sidebar templates, maps document names to template names. |
|
154 #html_sidebars = {} |
|
155 |
|
156 # Additional templates that should be rendered to pages, maps page names to |
|
157 # template names. |
|
158 #html_additional_pages = {} |
|
159 |
|
160 # If false, no module index is generated. |
|
161 html_use_modindex = True |
|
162 |
|
163 # If false, no index is generated. |
|
164 #html_use_index = True |
|
165 |
|
166 # If true, the index is split into individual pages for each letter. |
|
167 #html_split_index = False |
|
168 |
|
169 # If true, the reST sources are included in the HTML build as _sources/<name>. |
|
170 #html_copy_source = True |
|
171 |
|
172 # If true, an OpenSearch description file will be output, and all pages will |
|
173 # contain a <link> tag referring to it. The value of this option must be the |
|
174 # base URL from which the finished HTML is served. |
|
175 #html_use_opensearch = '' |
|
176 |
|
177 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). |
|
178 html_file_suffix = '.html' |
|
179 |
|
180 # Output file base name for HTML help builder. |
|
181 htmlhelp_basename = 'Cubicwebdoc' |
|
182 |
|
183 |
|
184 # Options for LaTeX output |
|
185 # ------------------------ |
|
186 |
|
187 # The paper size ('letter' or 'a4'). |
|
188 #latex_paper_size = 'letter' |
|
189 |
|
190 # The font size ('10pt', '11pt' or '12pt'). |
|
191 #latex_font_size = '10pt' |
|
192 |
|
193 # Grouping the document tree into LaTeX files. List of tuples |
|
194 # (source start file, target name, title, author, document class [howto/manual]). |
|
195 latex_documents = [ |
|
196 ('index', 'Cubicweb.tex', 'Cubicweb Documentation', |
|
197 'Logilab', 'manual'), |
|
198 ] |
|
199 |
|
200 # The name of an image file (relative to this directory) to place at the top of |
|
201 # the title page. |
|
202 #latex_logo = None |
|
203 |
|
204 # For "manual" documents, if this is true, then toplevel headings are parts, |
|
205 # not chapters. |
|
206 #latex_use_parts = False |
|
207 |
|
208 # Additional stuff for the LaTeX preamble. |
|
209 #latex_preamble = '' |
|
210 |
|
211 # Documents to append as an appendix to all manuals. |
|
212 #latex_appendices = [] |
|
213 |
|
214 # If false, no module index is generated. |
|
215 #latex_use_modindex = True |
|
216 |
|
217 #aafig_format = dict(latex='pdf', html='svg', text=None) |
|
218 |
|
219 rst_epilog = """ |
|
220 .. |cubicweb| replace:: *CubicWeb* |
|
221 .. |yams| replace:: *Yams* |
|
222 .. |rql| replace:: *RQL* |
|
223 """ |