|
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 templates — 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-templates"> |
|
54 <span id="pyams-template"></span><h1>PyAMS templates<a class="headerlink" href="#pyams-templates" title="Permalink to this headline">¶</a></h1> |
|
55 <div class="section" id="module-pyams_template"> |
|
56 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_template" title="Permalink to this headline">¶</a></h2> |
|
57 <dl class="function"> |
|
58 <dt id="pyams_template.includeme"> |
|
59 <code class="descclassname">pyams_template.</code><code class="descname">includeme</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_template.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_template.interfaces.html">pyams_template.interfaces package</a><ul> |
|
69 <li class="toctree-l2"><a class="reference internal" href="pyams_template.interfaces.html#module-pyams_template.interfaces">Module contents</a></li> |
|
70 </ul> |
|
71 </li> |
|
72 <li class="toctree-l1"><a class="reference internal" href="pyams_template.tests.html">pyams_template.tests package</a><ul> |
|
73 <li class="toctree-l2"><a class="reference internal" href="pyams_template.tests.html#submodules">Submodules</a></li> |
|
74 <li class="toctree-l2"><a class="reference internal" href="pyams_template.tests.html#module-pyams_template.tests.test_utilsdocs">pyams_template.tests.test_utilsdocs module</a></li> |
|
75 <li class="toctree-l2"><a class="reference internal" href="pyams_template.tests.html#module-pyams_template.tests.test_utilsdocstrings">pyams_template.tests.test_utilsdocstrings module</a></li> |
|
76 <li class="toctree-l2"><a class="reference internal" href="pyams_template.tests.html#module-pyams_template.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_template.template"> |
|
85 <span id="pyams-template-template-module"></span><h3>pyams_template.template module<a class="headerlink" href="#module-pyams_template.template" title="Permalink to this headline">¶</a></h3> |
|
86 <dl class="class"> |
|
87 <dt id="pyams_template.template.BoundViewTemplate"> |
|
88 <em class="property">class </em><code class="descclassname">pyams_template.template.</code><code class="descname">BoundViewTemplate</code><span class="sig-paren">(</span><em>pt</em>, <em>ob</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_template.template.BoundViewTemplate" title="Permalink to this definition">¶</a></dt> |
|
89 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
90 </dd></dl> |
|
91 |
|
92 <dl class="class"> |
|
93 <dt id="pyams_template.template.GetLayoutTemplate"> |
|
94 <em class="property">class </em><code class="descclassname">pyams_template.template.</code><code class="descname">GetLayoutTemplate</code><span class="sig-paren">(</span><em>name=''</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_template.template.GetLayoutTemplate" title="Permalink to this definition">¶</a></dt> |
|
95 <dd><p>Bases: <a class="reference internal" href="#pyams_template.template.ViewTemplate" title="pyams_template.template.ViewTemplate"><code class="xref py py-class docutils literal"><span class="pre">pyams_template.template.ViewTemplate</span></code></a></p> |
|
96 </dd></dl> |
|
97 |
|
98 <dl class="class"> |
|
99 <dt id="pyams_template.template.GetPageTemplate"> |
|
100 <em class="property">class </em><code class="descclassname">pyams_template.template.</code><code class="descname">GetPageTemplate</code><span class="sig-paren">(</span><em>name=''</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_template.template.GetPageTemplate" title="Permalink to this definition">¶</a></dt> |
|
101 <dd><p>Bases: <a class="reference internal" href="#pyams_template.template.ViewTemplate" title="pyams_template.template.ViewTemplate"><code class="xref py py-class docutils literal"><span class="pre">pyams_template.template.ViewTemplate</span></code></a></p> |
|
102 </dd></dl> |
|
103 |
|
104 <dl class="class"> |
|
105 <dt id="pyams_template.template.TemplateFactory"> |
|
106 <em class="property">class </em><code class="descclassname">pyams_template.template.</code><code class="descname">TemplateFactory</code><span class="sig-paren">(</span><em>filename</em>, <em>contentType</em>, <em>macro=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_template.template.TemplateFactory" title="Permalink to this definition">¶</a></dt> |
|
107 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
108 <p>Template factory.</p> |
|
109 <dl class="attribute"> |
|
110 <dt id="pyams_template.template.TemplateFactory.template"> |
|
111 <code class="descname">template</code><em class="property"> = None</em><a class="headerlink" href="#pyams_template.template.TemplateFactory.template" title="Permalink to this definition">¶</a></dt> |
|
112 <dd></dd></dl> |
|
113 |
|
114 </dd></dl> |
|
115 |
|
116 <dl class="class"> |
|
117 <dt id="pyams_template.template.ViewTemplate"> |
|
118 <em class="property">class </em><code class="descclassname">pyams_template.template.</code><code class="descname">ViewTemplate</code><span class="sig-paren">(</span><em>provides=<InterfaceClass pyams_template.interfaces.IPageTemplate></em>, <em>name=''</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_template.template.ViewTemplate" title="Permalink to this definition">¶</a></dt> |
|
119 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
120 </dd></dl> |
|
121 |
|
122 <dl class="attribute"> |
|
123 <dt id="pyams_template.template.get_layout_template"> |
|
124 <code class="descclassname">pyams_template.template.</code><code class="descname">get_layout_template</code><a class="headerlink" href="#pyams_template.template.get_layout_template" title="Permalink to this definition">¶</a></dt> |
|
125 <dd><p>alias of <a class="reference internal" href="#pyams_template.template.GetLayoutTemplate" title="pyams_template.template.GetLayoutTemplate"><code class="xref py py-class docutils literal"><span class="pre">GetLayoutTemplate</span></code></a></p> |
|
126 </dd></dl> |
|
127 |
|
128 <dl class="attribute"> |
|
129 <dt id="pyams_template.template.get_page_template"> |
|
130 <code class="descclassname">pyams_template.template.</code><code class="descname">get_page_template</code><a class="headerlink" href="#pyams_template.template.get_page_template" title="Permalink to this definition">¶</a></dt> |
|
131 <dd><p>alias of <a class="reference internal" href="#pyams_template.template.GetPageTemplate" title="pyams_template.template.GetPageTemplate"><code class="xref py py-class docutils literal"><span class="pre">GetPageTemplate</span></code></a></p> |
|
132 </dd></dl> |
|
133 |
|
134 <dl class="attribute"> |
|
135 <dt id="pyams_template.template.get_view_template"> |
|
136 <code class="descclassname">pyams_template.template.</code><code class="descname">get_view_template</code><a class="headerlink" href="#pyams_template.template.get_view_template" title="Permalink to this definition">¶</a></dt> |
|
137 <dd><p>alias of <a class="reference internal" href="#pyams_template.template.ViewTemplate" title="pyams_template.template.ViewTemplate"><code class="xref py py-class docutils literal"><span class="pre">ViewTemplate</span></code></a></p> |
|
138 </dd></dl> |
|
139 |
|
140 <dl class="class"> |
|
141 <dt id="pyams_template.template.layout_config"> |
|
142 <em class="property">class </em><code class="descclassname">pyams_template.template.</code><code class="descname">layout_config</code><span class="sig-paren">(</span><em>**settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_template.template.layout_config" title="Permalink to this definition">¶</a></dt> |
|
143 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
144 <p>Class decorator used to declare a layout template</p> |
|
145 <dl class="attribute"> |
|
146 <dt id="pyams_template.template.layout_config.venusian"> |
|
147 <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_template.template.layout_config.venusian" title="Permalink to this definition">¶</a></dt> |
|
148 <dd></dd></dl> |
|
149 |
|
150 </dd></dl> |
|
151 |
|
152 <dl class="class"> |
|
153 <dt id="pyams_template.template.template_config"> |
|
154 <em class="property">class </em><code class="descclassname">pyams_template.template.</code><code class="descname">template_config</code><span class="sig-paren">(</span><em>**settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_template.template.template_config" title="Permalink to this definition">¶</a></dt> |
|
155 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p> |
|
156 <p>Class decorator used to declare a view template</p> |
|
157 <dl class="attribute"> |
|
158 <dt id="pyams_template.template.template_config.venusian"> |
|
159 <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_template.template.template_config.venusian" title="Permalink to this definition">¶</a></dt> |
|
160 <dd></dd></dl> |
|
161 |
|
162 </dd></dl> |
|
163 |
|
164 </div> |
|
165 <div class="section" id="module-pyams_template.metadirectives"> |
|
166 <span id="pyams-template-metadirectives-module"></span><h3>pyams_template.metadirectives module<a class="headerlink" href="#module-pyams_template.metadirectives" title="Permalink to this headline">¶</a></h3> |
|
167 </div> |
|
168 <div class="section" id="module-pyams_template.metaconfigure"> |
|
169 <span id="pyams-template-metaconfigure-module"></span><h3>pyams_template.metaconfigure module<a class="headerlink" href="#module-pyams_template.metaconfigure" title="Permalink to this headline">¶</a></h3> |
|
170 <dl class="function"> |
|
171 <dt id="pyams_template.metaconfigure.layout_template_directive"> |
|
172 <code class="descclassname">pyams_template.metaconfigure.</code><code class="descname">layout_template_directive</code><span class="sig-paren">(</span><em>_context</em>, <em>template</em>, <em>name=''</em>, <em>for_=<InterfaceClass zope.interface.Interface></em>, <em>layer=<InterfaceClass pyramid.interfaces.IRequest></em>, <em>provides=<InterfaceClass pyams_template.interfaces.ILayoutTemplate></em>, <em>contentType='text/html'</em>, <em>macro=None</em>, <em>context=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_template.metaconfigure.layout_template_directive" title="Permalink to this definition">¶</a></dt> |
|
173 <dd></dd></dl> |
|
174 |
|
175 <dl class="function"> |
|
176 <dt id="pyams_template.metaconfigure.template_directive"> |
|
177 <code class="descclassname">pyams_template.metaconfigure.</code><code class="descname">template_directive</code><span class="sig-paren">(</span><em>_context</em>, <em>template</em>, <em>name=''</em>, <em>for_=<InterfaceClass zope.interface.Interface></em>, <em>layer=<InterfaceClass pyramid.interfaces.IRequest></em>, <em>provides=<InterfaceClass pyams_template.interfaces.IContentTemplate></em>, <em>contentType='text/html'</em>, <em>macro=None</em>, <em>context=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_template.metaconfigure.template_directive" title="Permalink to this definition">¶</a></dt> |
|
178 <dd></dd></dl> |
|
179 |
|
180 </div> |
|
181 </div> |
|
182 </div> |
|
183 |
|
184 |
|
185 </div> |
|
186 </div> |
|
187 </div> |
|
188 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
|
189 <div class="sphinxsidebarwrapper"> |
|
190 <h3><a href="index.html">Table Of Contents</a></h3> |
|
191 <ul> |
|
192 <li><a class="reference internal" href="#">PyAMS templates</a><ul> |
|
193 <li><a class="reference internal" href="#module-pyams_template">Module contents</a></li> |
|
194 <li><a class="reference internal" href="#subpackages">Subpackages</a></li> |
|
195 <li><a class="reference internal" href="#submodules">Submodules</a><ul> |
|
196 <li><a class="reference internal" href="#module-pyams_template.template">pyams_template.template module</a></li> |
|
197 <li><a class="reference internal" href="#module-pyams_template.metadirectives">pyams_template.metadirectives module</a></li> |
|
198 <li><a class="reference internal" href="#module-pyams_template.metaconfigure">pyams_template.metaconfigure module</a></li> |
|
199 </ul> |
|
200 </li> |
|
201 </ul> |
|
202 </li> |
|
203 </ul> |
|
204 |
|
205 <div id="searchbox" style="display: none" role="search"> |
|
206 <h3>Quick search</h3> |
|
207 <form class="search" action="search.html" method="get"> |
|
208 <div><input type="text" name="q" /></div> |
|
209 <div><input type="submit" value="Go" /></div> |
|
210 <input type="hidden" name="check_keywords" value="yes" /> |
|
211 <input type="hidden" name="area" value="default" /> |
|
212 </form> |
|
213 </div> |
|
214 <script type="text/javascript">$('#searchbox').show(0);</script> |
|
215 </div> |
|
216 </div> |
|
217 <div class="clearer"></div> |
|
218 </div> |
|
219 <div class="related" role="navigation" aria-label="related navigation"> |
|
220 <h3>Navigation</h3> |
|
221 <ul> |
|
222 <li class="right" style="margin-right: 10px"> |
|
223 <a href="genindex.html" title="General Index" |
|
224 >index</a></li> |
|
225 <li class="right" > |
|
226 <a href="py-modindex.html" title="Python Module Index" |
|
227 >modules</a> |</li> |
|
228 <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
229 </ul> |
|
230 </div> |
|
231 <div class="footer" role="contentinfo"> |
|
232 © Copyright 2017, Thierry Florac. |
|
233 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5. |
|
234 </div> |
|
235 </body> |
|
236 </html> |