|
1 |
|
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
4 |
|
5 <html xmlns="http://www.w3.org/1999/xhtml"> |
|
6 <head> |
|
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
|
8 <title>PyAMS pagelets — PyAMS User Guide 0.1.0 documentation</title> |
|
9 <link rel="stylesheet" href="_static/pyramid.css" type="text/css" /> |
|
10 <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
|
11 <script type="text/javascript"> |
|
12 var DOCUMENTATION_OPTIONS = { |
|
13 URL_ROOT: './', |
|
14 VERSION: '0.1.0', |
|
15 COLLAPSE_INDEX: false, |
|
16 FILE_SUFFIX: '.html', |
|
17 HAS_SOURCE: true, |
|
18 SOURCELINK_SUFFIX: '.txt' |
|
19 }; |
|
20 </script> |
|
21 <script type="text/javascript" src="_static/jquery.js"></script> |
|
22 <script type="text/javascript" src="_static/underscore.js"></script> |
|
23 <script type="text/javascript" src="_static/doctools.js"></script> |
|
24 <link rel="index" title="Index" href="genindex.html" /> |
|
25 <link rel="search" title="Search" href="search.html" /> |
|
26 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&subset=latin" type="text/css" media="screen" charset="utf-8" /> |
|
27 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&subset=latin" type="text/css" media="screen" charset="utf-8" /> |
|
28 <!--[if lte IE 6]> |
|
29 <link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" /> |
|
30 <![endif]--> |
|
31 |
|
32 </head> |
|
33 <body> |
|
34 |
|
35 <div class="related" role="navigation" aria-label="related navigation"> |
|
36 <h3>Navigation</h3> |
|
37 <ul> |
|
38 <li class="right" style="margin-right: 10px"> |
|
39 <a href="genindex.html" title="General Index" |
|
40 accesskey="I">index</a></li> |
|
41 <li class="right" > |
|
42 <a href="py-modindex.html" title="Python Module Index" |
|
43 >modules</a> |</li> |
|
44 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
45 </ul> |
|
46 </div> |
|
47 |
|
48 <div class="document"> |
|
49 <div class="documentwrapper"> |
|
50 <div class="bodywrapper"> |
|
51 <div class="body" role="main"> |
|
52 |
|
53 <div class="section" id="pyams-pagelets"> |
|
54 <span id="pyams-pagelet"></span><h1>PyAMS pagelets<a class="headerlink" href="#pyams-pagelets" title="Permalink to this headline">¶</a></h1> |
|
55 <div class="section" id="module-pyams_pagelet"> |
|
56 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_pagelet" title="Permalink to this headline">¶</a></h2> |
|
57 <dl class="function"> |
|
58 <dt id="pyams_pagelet.includeme"> |
|
59 <code class="descclassname">pyams_pagelet.</code><code class="descname">includeme</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_pagelet.includeme" title="Permalink to this definition">¶</a></dt> |
|
60 <dd><p>Pyramid include</p> |
|
61 </dd></dl> |
|
62 |
|
63 </div> |
|
64 <div class="section" id="subpackages"> |
|
65 <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2> |
|
66 <div class="toctree-wrapper compound"> |
|
67 <ul> |
|
68 <li class="toctree-l1"><a class="reference internal" href="pyams_pagelet.interfaces.html">pyams_pagelet.interfaces package</a><ul> |
|
69 <li class="toctree-l2"><a class="reference internal" href="pyams_pagelet.interfaces.html#module-pyams_pagelet.interfaces">Module contents</a></li> |
|
70 </ul> |
|
71 </li> |
|
72 <li class="toctree-l1"><a class="reference internal" href="pyams_pagelet.tests.html">pyams_pagelet.tests package</a><ul> |
|
73 <li class="toctree-l2"><a class="reference internal" href="pyams_pagelet.tests.html#submodules">Submodules</a></li> |
|
74 <li class="toctree-l2"><a class="reference internal" href="pyams_pagelet.tests.html#module-pyams_pagelet.tests.test_utilsdocs">pyams_pagelet.tests.test_utilsdocs module</a></li> |
|
75 <li class="toctree-l2"><a class="reference internal" href="pyams_pagelet.tests.html#module-pyams_pagelet.tests.test_utilsdocstrings">pyams_pagelet.tests.test_utilsdocstrings module</a></li> |
|
76 <li class="toctree-l2"><a class="reference internal" href="pyams_pagelet.tests.html#module-pyams_pagelet.tests">Module contents</a></li> |
|
77 </ul> |
|
78 </li> |
|
79 </ul> |
|
80 </div> |
|
81 </div> |
|
82 <div class="section" id="submodules"> |
|
83 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> |
|
84 <div class="section" id="module-pyams_pagelet.metaconfigure"> |
|
85 <span id="pyams-pagelet-metaconfigure-module"></span><h3>pyams_pagelet.metaconfigure module<a class="headerlink" href="#module-pyams_pagelet.metaconfigure" title="Permalink to this headline">¶</a></h3> |
|
86 <dl class="function"> |
|
87 <dt id="pyams_pagelet.metaconfigure.PageletDirective"> |
|
88 <code class="descclassname">pyams_pagelet.metaconfigure.</code><code class="descname">PageletDirective</code><span class="sig-paren">(</span><em>_context</em>, <em>name</em>, <em>view</em>, <em>context=<InterfaceClass zope.interface.Interface></em>, <em>permission=None</em>, <em>layer=<InterfaceClass pyramid.interfaces.IRequest></em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_pagelet.metaconfigure.PageletDirective" title="Permalink to this definition">¶</a></dt> |
|
89 <dd></dd></dl> |
|
90 |
|
91 </div> |
|
92 <div class="section" id="module-pyams_pagelet.metadirectives"> |
|
93 <span id="pyams-pagelet-metadirectives-module"></span><h3>pyams_pagelet.metadirectives module<a class="headerlink" href="#module-pyams_pagelet.metadirectives" title="Permalink to this headline">¶</a></h3> |
|
94 </div> |
|
95 <div class="section" id="module-pyams_pagelet.pagelet"> |
|
96 <span id="pyams-pagelet-pagelet-module"></span><h3>pyams_pagelet.pagelet module<a class="headerlink" href="#module-pyams_pagelet.pagelet" title="Permalink to this headline">¶</a></h3> |
|
97 <dl class="class"> |
|
98 <dt id="pyams_pagelet.pagelet.Pagelet"> |
|
99 <em class="property">class </em><code class="descclassname">pyams_pagelet.pagelet.</code><code class="descname">Pagelet</code><span class="sig-paren">(</span><em>context</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_pagelet.pagelet.Pagelet" title="Permalink to this definition">¶</a></dt> |
|
100 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
101 <p>Content provider with layout support</p> |
|
102 <dl class="attribute"> |
|
103 <dt id="pyams_pagelet.pagelet.Pagelet.layout"> |
|
104 <code class="descname">layout</code><em class="property"> = None</em><a class="headerlink" href="#pyams_pagelet.pagelet.Pagelet.layout" title="Permalink to this definition">¶</a></dt> |
|
105 <dd></dd></dl> |
|
106 |
|
107 <dl class="attribute"> |
|
108 <dt id="pyams_pagelet.pagelet.Pagelet.permission"> |
|
109 <code class="descname">permission</code><em class="property"> = None</em><a class="headerlink" href="#pyams_pagelet.pagelet.Pagelet.permission" title="Permalink to this definition">¶</a></dt> |
|
110 <dd></dd></dl> |
|
111 |
|
112 <dl class="method"> |
|
113 <dt id="pyams_pagelet.pagelet.Pagelet.render"> |
|
114 <code class="descname">render</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_pagelet.pagelet.Pagelet.render" title="Permalink to this definition">¶</a></dt> |
|
115 <dd></dd></dl> |
|
116 |
|
117 <dl class="attribute"> |
|
118 <dt id="pyams_pagelet.pagelet.Pagelet.template"> |
|
119 <code class="descname">template</code><em class="property"> = None</em><a class="headerlink" href="#pyams_pagelet.pagelet.Pagelet.template" title="Permalink to this definition">¶</a></dt> |
|
120 <dd></dd></dl> |
|
121 |
|
122 <dl class="method"> |
|
123 <dt id="pyams_pagelet.pagelet.Pagelet.update"> |
|
124 <code class="descname">update</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_pagelet.pagelet.Pagelet.update" title="Permalink to this definition">¶</a></dt> |
|
125 <dd></dd></dl> |
|
126 |
|
127 </dd></dl> |
|
128 |
|
129 <dl class="class"> |
|
130 <dt id="pyams_pagelet.pagelet.PageletRenderer"> |
|
131 <em class="property">class </em><code class="descclassname">pyams_pagelet.pagelet.</code><code class="descname">PageletRenderer</code><span class="sig-paren">(</span><em>context</em>, <em>request</em>, <em>pagelet</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_pagelet.pagelet.PageletRenderer" title="Permalink to this definition">¶</a></dt> |
|
132 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
133 <p>Pagelet renderer</p> |
|
134 <dl class="method"> |
|
135 <dt id="pyams_pagelet.pagelet.PageletRenderer.render"> |
|
136 <code class="descname">render</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_pagelet.pagelet.PageletRenderer.render" title="Permalink to this definition">¶</a></dt> |
|
137 <dd></dd></dl> |
|
138 |
|
139 <dl class="method"> |
|
140 <dt id="pyams_pagelet.pagelet.PageletRenderer.update"> |
|
141 <code class="descname">update</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_pagelet.pagelet.PageletRenderer.update" title="Permalink to this definition">¶</a></dt> |
|
142 <dd></dd></dl> |
|
143 |
|
144 </dd></dl> |
|
145 |
|
146 <dl class="class"> |
|
147 <dt id="pyams_pagelet.pagelet.pagelet_config"> |
|
148 <em class="property">class </em><code class="descclassname">pyams_pagelet.pagelet.</code><code class="descname">pagelet_config</code><span class="sig-paren">(</span><em>**settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_pagelet.pagelet.pagelet_config" title="Permalink to this definition">¶</a></dt> |
|
149 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
150 <p>Function or class decorator used to declare a pagelet</p> |
|
151 <dl class="attribute"> |
|
152 <dt id="pyams_pagelet.pagelet.pagelet_config.venusian"> |
|
153 <code class="descname">venusian</code><em class="property"> = <module 'venusian' from '/var/local/env/pycharm/lib/python3.5/site-packages/venusian/__init__.py'></em><a class="headerlink" href="#pyams_pagelet.pagelet.pagelet_config.venusian" title="Permalink to this definition">¶</a></dt> |
|
154 <dd></dd></dl> |
|
155 |
|
156 </dd></dl> |
|
157 |
|
158 </div> |
|
159 </div> |
|
160 </div> |
|
161 |
|
162 |
|
163 </div> |
|
164 </div> |
|
165 </div> |
|
166 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
|
167 <div class="sphinxsidebarwrapper"> |
|
168 <h3><a href="index.html">Table Of Contents</a></h3> |
|
169 <ul> |
|
170 <li><a class="reference internal" href="#">PyAMS pagelets</a><ul> |
|
171 <li><a class="reference internal" href="#module-pyams_pagelet">Module contents</a></li> |
|
172 <li><a class="reference internal" href="#subpackages">Subpackages</a></li> |
|
173 <li><a class="reference internal" href="#submodules">Submodules</a><ul> |
|
174 <li><a class="reference internal" href="#module-pyams_pagelet.metaconfigure">pyams_pagelet.metaconfigure module</a></li> |
|
175 <li><a class="reference internal" href="#module-pyams_pagelet.metadirectives">pyams_pagelet.metadirectives module</a></li> |
|
176 <li><a class="reference internal" href="#module-pyams_pagelet.pagelet">pyams_pagelet.pagelet module</a></li> |
|
177 </ul> |
|
178 </li> |
|
179 </ul> |
|
180 </li> |
|
181 </ul> |
|
182 |
|
183 <div id="searchbox" style="display: none" role="search"> |
|
184 <h3>Quick search</h3> |
|
185 <form class="search" action="search.html" method="get"> |
|
186 <div><input type="text" name="q" /></div> |
|
187 <div><input type="submit" value="Go" /></div> |
|
188 <input type="hidden" name="check_keywords" value="yes" /> |
|
189 <input type="hidden" name="area" value="default" /> |
|
190 </form> |
|
191 </div> |
|
192 <script type="text/javascript">$('#searchbox').show(0);</script> |
|
193 </div> |
|
194 </div> |
|
195 <div class="clearer"></div> |
|
196 </div> |
|
197 <div class="related" role="navigation" aria-label="related navigation"> |
|
198 <h3>Navigation</h3> |
|
199 <ul> |
|
200 <li class="right" style="margin-right: 10px"> |
|
201 <a href="genindex.html" title="General Index" |
|
202 >index</a></li> |
|
203 <li class="right" > |
|
204 <a href="py-modindex.html" title="Python Module Index" |
|
205 >modules</a> |</li> |
|
206 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
207 </ul> |
|
208 </div> |
|
209 <div class="footer" role="contentinfo"> |
|
210 © Copyright 2017, Thierry Florac. |
|
211 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5. |
|
212 </div> |
|
213 </body> |
|
214 </html> |