author | Aurelien Campeas <aurelien.campeas@logilab.fr> |
Thu, 09 Jul 2009 17:16:49 +0200 | |
branch | stable |
changeset 2361 | 8f00836580f1 |
parent 1977 | 606923dff11b |
child 4212 | ab6573088b4a |
permissions | -rw-r--r-- |
0 | 1 |
# -*- coding: utf-8 -*- |
1977
606923dff11b
big bunch of copyright / docstring update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1802
diff
changeset
|
2 |
""" |
606923dff11b
big bunch of copyright / docstring update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1802
diff
changeset
|
3 |
|
606923dff11b
big bunch of copyright / docstring update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1802
diff
changeset
|
4 |
:organization: Logilab |
606923dff11b
big bunch of copyright / docstring update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1802
diff
changeset
|
5 |
:copyright: 2001-2009 LOGILAB S.A. (Paris, FRANCE), license is LGPL v2. |
606923dff11b
big bunch of copyright / docstring update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1802
diff
changeset
|
6 |
:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr |
606923dff11b
big bunch of copyright / docstring update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1802
diff
changeset
|
7 |
:license: GNU Lesser General Public License, v2.1 - http://www.gnu.org/licenses |
606923dff11b
big bunch of copyright / docstring update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
1802
diff
changeset
|
8 |
""" |
0 | 9 |
# |
10 |
# Cubicweb documentation build configuration file, created by |
|
11 |
# sphinx-quickstart on Fri Oct 31 09:10:36 2008. |
|
12 |
# |
|
13 |
# This file is execfile()d with the current directory set to its containing dir. |
|
14 |
# |
|
15 |
# The contents of this file are pickled, so don't put values in the namespace |
|
16 |
# that aren't pickleable (module imports are okay, they're removed automatically). |
|
17 |
# |
|
18 |
# All configuration values have a default value; values that are commented out |
|
19 |
# serve to show the default value. |
|
20 |
||
21 |
import sys, os |
|
22 |
||
23 |
# If your extensions are in another directory, add it here. If the directory |
|
24 |
# is relative to the documentation root, use os.path.abspath to make it |
|
25 |
# absolute, like shown here. |
|
26 |
#sys.path.append(os.path.abspath('some/directory')) |
|
27 |
||
28 |
# General configuration |
|
29 |
# --------------------- |
|
30 |
||
31 |
# Add any Sphinx extension module names here, as strings. They can be extensions |
|
32 |
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
|
1
88d637274072
Add modules to list and to index to have docstring integrated into the documentation.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
0
diff
changeset
|
33 |
extensions = ['sphinx.ext.autodoc'] |
88d637274072
Add modules to list and to index to have docstring integrated into the documentation.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
0
diff
changeset
|
34 |
autoclass_content = 'both' |
0 | 35 |
# Add any paths that contain templates here, relative to this directory. |
36 |
templates_path = ['.templates'] |
|
37 |
||
38 |
# The suffix of source filenames. |
|
39 |
source_suffix = '.txt' |
|
40 |
||
41 |
# The master toctree document. |
|
70
f80ac3de185b
Rename index file from indef.fr.txt to index.txt to dit Sphinx needs and adjusted conf file in consequence.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
54
diff
changeset
|
42 |
master_doc = 'index' |
0 | 43 |
|
44 |
# General substitutions. |
|
45 |
project = 'Cubicweb' |
|
1802
d628defebc17
delete-trailing-whitespace + some copyright update
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
70
diff
changeset
|
46 |
copyright = '2008-2009, Logilab' |
0 | 47 |
|
48 |
# The default replacements for |version| and |release|, also used in various |
|
49 |
# other places throughout the built documents. |
|
50 |
# |
|
51 |
# The short X.Y version. |
|
52 |
version = '0.54' |
|
53 |
# The full version, including alpha/beta/rc tags. |
|
34
88b4a6475a26
Changed title format in relbar so that it will look like "CubicWeb 3.0"
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
31
diff
changeset
|
54 |
release = '3.0' |
0 | 55 |
|
56 |
# There are two options for replacing |today|: either, you set today to some |
|
57 |
# non-false value, then it is used: |
|
58 |
#today = '' |
|
59 |
# Else, today_fmt is used as the format for a strftime call. |
|
60 |
today_fmt = '%B %d, %Y' |
|
61 |
||
62 |
# List of documents that shouldn't be included in the build. |
|
63 |
#unused_docs = [] |
|
64 |
||
65 |
# List of directories, relative to source directories, that shouldn't be searched |
|
66 |
# for source files. |
|
67 |
#exclude_dirs = [] |
|
68 |
||
69 |
# The reST default role (used for this markup: `text`) to use for all documents. |
|
70 |
#default_role = None |
|
71 |
||
72 |
# If true, '()' will be appended to :func: etc. cross-reference text. |
|
73 |
#add_function_parentheses = True |
|
74 |
||
75 |
# If true, the current module name will be prepended to all description |
|
76 |
# unit titles (such as .. function::). |
|
77 |
#add_module_names = True |
|
78 |
||
79 |
# If true, sectionauthor and moduleauthor directives will be shown in the |
|
80 |
# output. They are ignored by default. |
|
81 |
#show_authors = False |
|
82 |
||
83 |
# The name of the Pygments (syntax highlighting) style to use. |
|
84 |
pygments_style = 'sphinx' |
|
85 |
||
86 |
||
87 |
# Options for HTML output |
|
88 |
# ----------------------- |
|
89 |
||
90 |
# The style sheet to use for HTML and HTML Help pages. A file of that name |
|
91 |
# must exist either in Sphinx' static/ path, or in one of the custom paths |
|
92 |
# given in html_static_path. |
|
93 |
html_style = 'sphinx-default.css' |
|
94 |
||
95 |
# The name for this set of Sphinx documents. If None, it defaults to |
|
96 |
# "<project> v<release> documentation". |
|
34
88b4a6475a26
Changed title format in relbar so that it will look like "CubicWeb 3.0"
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
31
diff
changeset
|
97 |
html_title = '%s %s' % (project, release) |
0 | 98 |
|
99 |
# A shorter title for the navigation bar. Default is the same as html_title. |
|
100 |
#html_short_title = None |
|
101 |
||
102 |
# The name of an image file (within the static path) to place at the top of |
|
103 |
# the sidebar. |
|
104 |
#html_logo = None |
|
105 |
||
106 |
# The name of an image file (within the static path) to use as favicon of the |
|
107 |
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
|
108 |
# pixels large. |
|
109 |
#html_favicon = None |
|
110 |
||
111 |
# Add any paths that contain custom static files (such as style sheets) here, |
|
112 |
# relative to this directory. They are copied after the builtin static files, |
|
113 |
# so a file named "default.css" will overwrite the builtin "default.css". |
|
114 |
html_static_path = ['.static'] |
|
115 |
||
116 |
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
|
117 |
# using the given strftime format. |
|
118 |
html_last_updated_fmt = '%b %d, %Y' |
|
119 |
||
120 |
# If true, SmartyPants will be used to convert quotes and dashes to |
|
121 |
# typographically correct entities. |
|
122 |
#html_use_smartypants = True |
|
123 |
||
124 |
# Custom sidebar templates, maps document names to template names. |
|
125 |
#html_sidebars = {} |
|
126 |
||
127 |
# Additional templates that should be rendered to pages, maps page names to |
|
128 |
# template names. |
|
129 |
#html_additional_pages = {} |
|
130 |
||
131 |
# If false, no module index is generated. |
|
1
88d637274072
Add modules to list and to index to have docstring integrated into the documentation.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
0
diff
changeset
|
132 |
html_use_modindex = True |
0 | 133 |
|
134 |
# If false, no index is generated. |
|
135 |
#html_use_index = True |
|
136 |
||
137 |
# If true, the index is split into individual pages for each letter. |
|
138 |
#html_split_index = False |
|
139 |
||
140 |
# If true, the reST sources are included in the HTML build as _sources/<name>. |
|
141 |
#html_copy_source = True |
|
142 |
||
143 |
# If true, an OpenSearch description file will be output, and all pages will |
|
144 |
# contain a <link> tag referring to it. The value of this option must be the |
|
145 |
# base URL from which the finished HTML is served. |
|
146 |
#html_use_opensearch = '' |
|
147 |
||
148 |
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). |
|
1
88d637274072
Add modules to list and to index to have docstring integrated into the documentation.
Sandrine Ribeau <sandrine.ribeau@logilab.fr>
parents:
0
diff
changeset
|
149 |
html_file_suffix = '.html' |
0 | 150 |
|
151 |
# Output file base name for HTML help builder. |
|
152 |
htmlhelp_basename = 'Cubicwebdoc' |
|
153 |
||
154 |
||
155 |
# Options for LaTeX output |
|
156 |
# ------------------------ |
|
157 |
||
158 |
# The paper size ('letter' or 'a4'). |
|
159 |
#latex_paper_size = 'letter' |
|
160 |
||
161 |
# The font size ('10pt', '11pt' or '12pt'). |
|
162 |
#latex_font_size = '10pt' |
|
163 |
||
164 |
# Grouping the document tree into LaTeX files. List of tuples |
|
165 |
# (source start file, target name, title, author, document class [howto/manual]). |
|
166 |
latex_documents = [ |
|
167 |
('index', 'Cubicweb.tex', 'Cubicweb Documentation', |
|
31
6cb1b501a044
replace "Logilab Inc" with "Logilab".
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
1
diff
changeset
|
168 |
'Logilab', 'manual'), |
0 | 169 |
] |
170 |
||
171 |
# The name of an image file (relative to this directory) to place at the top of |
|
172 |
# the title page. |
|
173 |
#latex_logo = None |
|
174 |
||
175 |
# For "manual" documents, if this is true, then toplevel headings are parts, |
|
176 |
# not chapters. |
|
177 |
#latex_use_parts = False |
|
178 |
||
179 |
# Additional stuff for the LaTeX preamble. |
|
180 |
#latex_preamble = '' |
|
181 |
||
182 |
# Documents to append as an appendix to all manuals. |
|
183 |
#latex_appendices = [] |
|
184 |
||
185 |
# If false, no module index is generated. |
|
186 |
#latex_use_modindex = True |