|
1 # -*- coding: utf-8 -*- |
|
2 # |
|
3 # Pyramid Cubicweb documentation build configuration file, created by |
|
4 # sphinx-quickstart on Sat Jan 3 21:00:05 2015. |
|
5 # |
|
6 # This file is execfile()d with the current directory set to its |
|
7 # containing dir. |
|
8 # |
|
9 # Note that not all possible configuration values are present in this |
|
10 # autogenerated file. |
|
11 # |
|
12 # All configuration values have a default; values that are commented out |
|
13 # serve to show the default. |
|
14 |
|
15 import sys |
|
16 import os |
|
17 |
|
18 # If extensions (or modules to document with autodoc) are in another directory, |
|
19 # add these directories to sys.path here. If the directory is relative to the |
|
20 # documentation root, use os.path.abspath to make it absolute, like shown here. |
|
21 #sys.path.insert(0, os.path.abspath('.')) |
|
22 |
|
23 # -- General configuration ------------------------------------------------ |
|
24 |
|
25 # If your documentation needs a minimal Sphinx version, state it here. |
|
26 #needs_sphinx = '1.0' |
|
27 |
|
28 # Add any Sphinx extension module names here, as strings. They can be |
|
29 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
|
30 # ones. |
|
31 extensions = [ |
|
32 'sphinx.ext.autodoc', |
|
33 'sphinx.ext.intersphinx', |
|
34 'sphinx.ext.coverage', |
|
35 'sphinx.ext.viewcode', |
|
36 ] |
|
37 |
|
38 # Add any paths that contain templates here, relative to this directory. |
|
39 templates_path = ['_templates'] |
|
40 |
|
41 # The suffix of source filenames. |
|
42 source_suffix = '.rst' |
|
43 |
|
44 # The encoding of source files. |
|
45 #source_encoding = 'utf-8-sig' |
|
46 |
|
47 # The master toctree document. |
|
48 master_doc = 'index' |
|
49 |
|
50 # General information about the project. |
|
51 project = u'Pyramid Cubicweb' |
|
52 copyright = u'2015, Christophe de Vienne' |
|
53 |
|
54 # The version info for the project you're documenting, acts as replacement for |
|
55 # |version| and |release|, also used in various other places throughout the |
|
56 # built documents. |
|
57 # |
|
58 # The short X.Y version. |
|
59 import pkg_resources |
|
60 |
|
61 d = pkg_resources.require('pyramid_cubicweb') |
|
62 |
|
63 version = d[0].version.split('.')[:2] |
|
64 |
|
65 # The full version, including alpha/beta/rc tags. |
|
66 release = d[0].version |
|
67 |
|
68 # The language for content autogenerated by Sphinx. Refer to documentation |
|
69 # for a list of supported languages. |
|
70 #language = None |
|
71 |
|
72 # There are two options for replacing |today|: either, you set today to some |
|
73 # non-false value, then it is used: |
|
74 #today = '' |
|
75 # Else, today_fmt is used as the format for a strftime call. |
|
76 #today_fmt = '%B %d, %Y' |
|
77 |
|
78 # List of patterns, relative to source directory, that match files and |
|
79 # directories to ignore when looking for source files. |
|
80 exclude_patterns = ['_build'] |
|
81 |
|
82 # The reST default role (used for this markup: `text`) to use for all |
|
83 # documents. |
|
84 #default_role = None |
|
85 |
|
86 # If true, '()' will be appended to :func: etc. cross-reference text. |
|
87 #add_function_parentheses = True |
|
88 |
|
89 # If true, the current module name will be prepended to all description |
|
90 # unit titles (such as .. function::). |
|
91 #add_module_names = True |
|
92 |
|
93 # If true, sectionauthor and moduleauthor directives will be shown in the |
|
94 # output. They are ignored by default. |
|
95 #show_authors = False |
|
96 |
|
97 # The name of the Pygments (syntax highlighting) style to use. |
|
98 pygments_style = 'sphinx' |
|
99 |
|
100 # A list of ignored prefixes for module index sorting. |
|
101 #modindex_common_prefix = [] |
|
102 |
|
103 # If true, keep warnings as "system message" paragraphs in the built documents. |
|
104 #keep_warnings = False |
|
105 |
|
106 |
|
107 # -- Options for HTML output ---------------------------------------------- |
|
108 |
|
109 # The theme to use for HTML and HTML Help pages. See the documentation for |
|
110 # a list of builtin themes. |
|
111 import sphinx_rtd_theme |
|
112 html_theme = 'sphinx_rtd_theme' |
|
113 |
|
114 # Theme options are theme-specific and customize the look and feel of a theme |
|
115 # further. For a list of options available for each theme, see the |
|
116 # documentation. |
|
117 #html_theme_options = {} |
|
118 |
|
119 # Add any paths that contain custom themes here, relative to this directory. |
|
120 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] |
|
121 |
|
122 # The name for this set of Sphinx documents. If None, it defaults to |
|
123 # "<project> v<release> documentation". |
|
124 #html_title = None |
|
125 |
|
126 # A shorter title for the navigation bar. Default is the same as html_title. |
|
127 #html_short_title = None |
|
128 |
|
129 # The name of an image file (relative to this directory) to place at the top |
|
130 # of the sidebar. |
|
131 #html_logo = None |
|
132 |
|
133 # The name of an image file (within the static path) to use as favicon of the |
|
134 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
|
135 # pixels large. |
|
136 #html_favicon = None |
|
137 |
|
138 # Add any paths that contain custom static files (such as style sheets) here, |
|
139 # relative to this directory. They are copied after the builtin static files, |
|
140 # so a file named "default.css" will overwrite the builtin "default.css". |
|
141 html_static_path = ['_static'] |
|
142 |
|
143 # Add any extra paths that contain custom files (such as robots.txt or |
|
144 # .htaccess) here, relative to this directory. These files are copied |
|
145 # directly to the root of the documentation. |
|
146 #html_extra_path = [] |
|
147 |
|
148 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
|
149 # using the given strftime format. |
|
150 #html_last_updated_fmt = '%b %d, %Y' |
|
151 |
|
152 # If true, SmartyPants will be used to convert quotes and dashes to |
|
153 # typographically correct entities. |
|
154 #html_use_smartypants = True |
|
155 |
|
156 # Custom sidebar templates, maps document names to template names. |
|
157 #html_sidebars = {} |
|
158 |
|
159 # Additional templates that should be rendered to pages, maps page names to |
|
160 # template names. |
|
161 #html_additional_pages = {} |
|
162 |
|
163 # If false, no module index is generated. |
|
164 #html_domain_indices = True |
|
165 |
|
166 # If false, no index is generated. |
|
167 #html_use_index = True |
|
168 |
|
169 # If true, the index is split into individual pages for each letter. |
|
170 #html_split_index = False |
|
171 |
|
172 # If true, links to the reST sources are added to the pages. |
|
173 #html_show_sourcelink = True |
|
174 |
|
175 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
|
176 #html_show_sphinx = True |
|
177 |
|
178 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
|
179 #html_show_copyright = True |
|
180 |
|
181 # If true, an OpenSearch description file will be output, and all pages will |
|
182 # contain a <link> tag referring to it. The value of this option must be the |
|
183 # base URL from which the finished HTML is served. |
|
184 #html_use_opensearch = '' |
|
185 |
|
186 # This is the file name suffix for HTML files (e.g. ".xhtml"). |
|
187 #html_file_suffix = None |
|
188 |
|
189 # Output file base name for HTML help builder. |
|
190 htmlhelp_basename = 'PyramidCubicwebdoc' |
|
191 |
|
192 |
|
193 # -- Options for LaTeX output --------------------------------------------- |
|
194 |
|
195 latex_elements = { |
|
196 # The paper size ('letterpaper' or 'a4paper'). |
|
197 #'papersize': 'letterpaper', |
|
198 |
|
199 # The font size ('10pt', '11pt' or '12pt'). |
|
200 #'pointsize': '10pt', |
|
201 |
|
202 # Additional stuff for the LaTeX preamble. |
|
203 #'preamble': '', |
|
204 } |
|
205 |
|
206 # Grouping the document tree into LaTeX files. List of tuples |
|
207 # (source start file, target name, title, |
|
208 # author, documentclass [howto, manual, or own class]). |
|
209 latex_documents = [ |
|
210 ('index', 'PyramidCubicweb.tex', u'Pyramid Cubicweb Documentation', |
|
211 u'Christophe de Vienne', 'manual'), |
|
212 ] |
|
213 |
|
214 # The name of an image file (relative to this directory) to place at the top of |
|
215 # the title page. |
|
216 #latex_logo = None |
|
217 |
|
218 # For "manual" documents, if this is true, then toplevel headings are parts, |
|
219 # not chapters. |
|
220 #latex_use_parts = False |
|
221 |
|
222 # If true, show page references after internal links. |
|
223 #latex_show_pagerefs = False |
|
224 |
|
225 # If true, show URL addresses after external links. |
|
226 #latex_show_urls = False |
|
227 |
|
228 # Documents to append as an appendix to all manuals. |
|
229 #latex_appendices = [] |
|
230 |
|
231 # If false, no module index is generated. |
|
232 #latex_domain_indices = True |
|
233 |
|
234 |
|
235 # -- Options for manual page output --------------------------------------- |
|
236 |
|
237 # One entry per manual page. List of tuples |
|
238 # (source start file, name, description, authors, manual section). |
|
239 man_pages = [ |
|
240 ('index', 'pyramidcubicweb', u'Pyramid Cubicweb Documentation', |
|
241 [u'Christophe de Vienne'], 1) |
|
242 ] |
|
243 |
|
244 # If true, show URL addresses after external links. |
|
245 #man_show_urls = False |
|
246 |
|
247 |
|
248 # -- Options for Texinfo output ------------------------------------------- |
|
249 |
|
250 # Grouping the document tree into Texinfo files. List of tuples |
|
251 # (source start file, target name, title, author, |
|
252 # dir menu entry, description, category) |
|
253 texinfo_documents = [ |
|
254 ('index', 'PyramidCubicweb', u'Pyramid Cubicweb Documentation', |
|
255 u'Christophe de Vienne', 'PyramidCubicweb', 'One line description of project.', |
|
256 'Miscellaneous'), |
|
257 ] |
|
258 |
|
259 # Documents to append as an appendix to all manuals. |
|
260 #texinfo_appendices = [] |
|
261 |
|
262 # If false, no module index is generated. |
|
263 #texinfo_domain_indices = True |
|
264 |
|
265 # How to display URL addresses: 'footnote', 'no', or 'inline'. |
|
266 #texinfo_show_urls = 'footnote' |
|
267 |
|
268 # If true, do not generate a @detailmenu in the "Top" node's menu. |
|
269 #texinfo_no_detailmenu = False |
|
270 |
|
271 |
|
272 # Example configuration for intersphinx: refer to the Python standard library. |
|
273 intersphinx_mapping = { |
|
274 'http://docs.python.org/': None, |
|
275 'http://pyramid.readthedocs.org/en/latest/': None, |
|
276 'http://docs.cubicweb.org/': None |
|
277 } |
|
278 |
|
279 |
|
280 def setup(app): |
|
281 app.add_object_type('confval', 'confval', |
|
282 objname='configuration value', |
|
283 indextemplate='pair: %s; configuration value') |