1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>fake_project.nested_folder package — fake_project documentation</title>
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="python" href="modules.html" />
<link rel="prev" title="fake_project package" href="fake_project.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="fake-project-nested-folder-package">
<h1>fake_project.nested_folder package<a class="headerlink" href="#fake-project-nested-folder-package" title="Permalink to this headline">¶</a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="module-fake_project.nested_folder.another">
<span id="fake-project-nested-folder-another-module"></span><h2>fake_project.nested_folder.another module<a class="headerlink" href="#module-fake_project.nested_folder.another" title="Permalink to this headline">¶</a></h2>
<p>A module that shows every type of documentable class / method / function.</p>
<dl class="attribute">
<dt id="fake_project.nested_folder.another.ATTRIBUTE_VALUE">
<code class="descclassname">fake_project.nested_folder.another.</code><code class="descname">ATTRIBUTE_VALUE</code><a class="headerlink" href="#fake_project.nested_folder.another.ATTRIBUTE_VALUE" title="Permalink to this definition">¶</a></dt>
<dd><p>Some number.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">float</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="fake_project.nested_folder.another.MyKlass">
<em class="property">class </em><code class="descclassname">fake_project.nested_folder.another.</code><code class="descname">MyKlass</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/fake_project/nested_folder/another.html#MyKlass"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fake_project.nested_folder.another.MyKlass" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>A class that does something.</p>
<p>Multi-line information here.</p>
<dl class="attribute">
<dt id="fake_project.nested_folder.another.MyKlass.attribute_value">
<code class="descname">attribute_value</code><a class="headerlink" href="#fake_project.nested_folder.another.MyKlass.attribute_value" title="Permalink to this definition">¶</a></dt>
<dd><p>Some string.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt>
<code class="descname">attribute_value</code><em class="property"> = 'asdfasdf'</em></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="fake_project.nested_folder.another.MyKlass.get_classmethod">
<em class="property">classmethod </em><code class="descname">get_classmethod</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/fake_project/nested_folder/another.html#MyKlass.get_classmethod"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fake_project.nested_folder.another.MyKlass.get_classmethod" title="Permalink to this definition">¶</a></dt>
<dd><p>int: Get some value.</p>
</dd></dl>
<dl class="method">
<dt id="fake_project.nested_folder.another.MyKlass.get_method">
<code class="descname">get_method</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/fake_project/nested_folder/another.html#MyKlass.get_method"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fake_project.nested_folder.another.MyKlass.get_method" title="Permalink to this definition">¶</a></dt>
<dd><p>int: Get some value.</p>
</dd></dl>
<dl class="staticmethod">
<dt id="fake_project.nested_folder.another.MyKlass.get_staticmethod">
<em class="property">static </em><code class="descname">get_staticmethod</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/fake_project/nested_folder/another.html#MyKlass.get_staticmethod"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fake_project.nested_folder.another.MyKlass.get_staticmethod" title="Permalink to this definition">¶</a></dt>
<dd><p>int: Get some value.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="fake_project.nested_folder.another.ParentClass">
<em class="property">class </em><code class="descclassname">fake_project.nested_folder.another.</code><code class="descname">ParentClass</code><a class="reference internal" href="../_modules/fake_project/nested_folder/another.html#ParentClass"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fake_project.nested_folder.another.ParentClass" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>The outter class.</p>
<dl class="attribute">
<dt id="fake_project.nested_folder.another.ParentClass.attribute_value">
<code class="descname">attribute_value</code><a class="headerlink" href="#fake_project.nested_folder.another.ParentClass.attribute_value" title="Permalink to this definition">¶</a></dt>
<dd><p>Some string.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="fake_project.nested_folder.another.ParentClass.NestedClass">
<em class="property">class </em><code class="descname">NestedClass</code><a class="reference internal" href="../_modules/fake_project/nested_folder/another.html#ParentClass.NestedClass"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fake_project.nested_folder.another.ParentClass.NestedClass" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>A class within a class.</p>
<dl class="attribute">
<dt id="fake_project.nested_folder.another.ParentClass.NestedClass.attribute_value">
<code class="descname">attribute_value</code><a class="headerlink" href="#fake_project.nested_folder.another.ParentClass.NestedClass.attribute_value" title="Permalink to this definition">¶</a></dt>
<dd><p>Some string.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt>
<code class="descname">attribute_value</code><em class="property"> = 'zzzzzzzzzzzzz'</em></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="fake_project.nested_folder.another.ParentClass.NestedClass.get_classmethod">
<em class="property">classmethod </em><code class="descname">get_classmethod</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/fake_project/nested_folder/another.html#ParentClass.NestedClass.get_classmethod"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fake_project.nested_folder.another.ParentClass.NestedClass.get_classmethod" title="Permalink to this definition">¶</a></dt>
<dd><p>int: Get some value.</p>
</dd></dl>
<dl class="method">
<dt id="fake_project.nested_folder.another.ParentClass.NestedClass.get_method">
<code class="descname">get_method</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/fake_project/nested_folder/another.html#ParentClass.NestedClass.get_method"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fake_project.nested_folder.another.ParentClass.NestedClass.get_method" title="Permalink to this definition">¶</a></dt>
<dd><p>int: Get some value.</p>
</dd></dl>
<dl class="staticmethod">
<dt id="fake_project.nested_folder.another.ParentClass.NestedClass.get_staticmethod">
<em class="property">static </em><code class="descname">get_staticmethod</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/fake_project/nested_folder/another.html#ParentClass.NestedClass.get_staticmethod"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fake_project.nested_folder.another.ParentClass.NestedClass.get_staticmethod" title="Permalink to this definition">¶</a></dt>
<dd><p>int: Get some value.</p>
</dd></dl>
</dd></dl>
<dl class="attribute">
<dt>
<code class="descname">attribute_value</code><em class="property"> = 'tttt'</em></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="fake_project.nested_folder.another.ParentClass.get_classmethod">
<em class="property">classmethod </em><code class="descname">get_classmethod</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/fake_project/nested_folder/another.html#ParentClass.get_classmethod"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fake_project.nested_folder.another.ParentClass.get_classmethod" title="Permalink to this definition">¶</a></dt>
<dd><p>int: Get some value.</p>
</dd></dl>
<dl class="method">
<dt id="fake_project.nested_folder.another.ParentClass.get_method">
<code class="descname">get_method</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/fake_project/nested_folder/another.html#ParentClass.get_method"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fake_project.nested_folder.another.ParentClass.get_method" title="Permalink to this definition">¶</a></dt>
<dd><p>int: Get some value.</p>
</dd></dl>
<dl class="staticmethod">
<dt id="fake_project.nested_folder.another.ParentClass.get_staticmethod">
<em class="property">static </em><code class="descname">get_staticmethod</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/fake_project/nested_folder/another.html#ParentClass.get_staticmethod"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fake_project.nested_folder.another.ParentClass.get_staticmethod" title="Permalink to this definition">¶</a></dt>
<dd><p>int: Get some value.</p>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="fake_project.nested_folder.another._set_private_function_thing">
<code class="descclassname">fake_project.nested_folder.another.</code><code class="descname">_set_private_function_thing</code><span class="sig-paren">(</span><em>value</em>, <em>another</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/fake_project/nested_folder/another.html#_set_private_function_thing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fake_project.nested_folder.another._set_private_function_thing" title="Permalink to this definition">¶</a></dt>
<dd><p>Do something here.</p>
</dd></dl>
<dl class="function">
<dt id="fake_project.nested_folder.another.set_function_thing">
<code class="descclassname">fake_project.nested_folder.another.</code><code class="descname">set_function_thing</code><span class="sig-paren">(</span><em>value</em>, <em>another</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/fake_project/nested_folder/another.html#set_function_thing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#fake_project.nested_folder.another.set_function_thing" title="Permalink to this definition">¶</a></dt>
<dd><p>Do something here.</p>
</dd></dl>
</div>
<div class="section" id="module-fake_project.nested_folder">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-fake_project.nested_folder" title="Permalink to this headline">¶</a></h2>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">fake_project</a></h1>
<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../api_documentation.html">API Documentation</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li><a href="../api_documentation.html">API Documentation</a><ul>
<li><a href="fake_project.html">fake_project package</a><ul>
<li>Previous: <a href="fake_project.html" title="previous chapter">fake_project package</a></li>
<li>Next: <a href="modules.html" title="next chapter">python</a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2019, Me.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.5</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="../_sources/api/fake_project.nested_folder.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>
|
