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
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>inspect_string | My Python Project</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
<link rel="stylesheet" href="m-dark+documentation.compiled.css" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
</head>
<body>
<header><nav id="navigation">
<div class="m-container">
<div class="m-row">
<a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">My Python Project</a>
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
</div>
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
<div class="m-row">
<ol class="m-col-t-12 m-col-m-none">
<li><a href="modules.html">Modules</a></li>
<li><a href="classes.html">Classes</a></li>
</ol>
</div>
</div>
</div>
</div>
</nav></header>
<main><article>
<div class="m-container m-container-inflatable">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<h1>
inspect_string <span class="m-thin">module</span>
</h1>
<p>A module</p>
<nav class="m-block m-default">
<h3>Contents</h3>
<ul>
<li>
Reference
<ul>
<li><a href="#packages">Modules</a></li>
<li><a href="#classes">Classes</a></li>
<li><a href="#enums">Enums</a></li>
<li><a href="#functions">Functions</a></li>
<li><a href="#data">Data</a></li>
</ul>
</li>
</ul>
</nav>
<section id="namespaces">
<h2><a href="#namespaces">Modules</a></h2>
<dl class="m-doc">
<dt>module <a href="inspect_string.another_module.html" class="m-doc">another_module</a></dt>
<dd>Another module</dd>
<dt>module <a href="inspect_string.subpackage.html" class="m-doc">subpackage</a></dt>
<dd>A subpackage</dd>
</dl>
</section>
<section id="classes">
<h2><a href="#classes">Classes</a></h2>
<dl class="m-doc">
<dt>class <a href="inspect_string.DerivedException.html" class="m-doc">DerivedException</a></dt>
<dd>A class deriving from BaseException, which has the weird args getset_descriptor</dd>
<dt>class <a href="inspect_string.Foo.html" class="m-doc">Foo</a></dt>
<dd>The foo class</dd>
<dt>class <a href="inspect_string.FooSlots.html" class="m-doc">FooSlots</a></dt>
<dd>A class with slots. Can't have docstrings for these.</dd>
<dt>class <a href="inspect_string.Specials.html" class="m-doc">Specials</a></dt>
<dd>Special class members</dd>
</dl>
</section>
<section id="enums">
<h2><a href="#enums">Enums</a></h2>
<dl class="m-doc">
<dt>
<span class="m-doc-wrap-bumper">class <a href="#MyEnum" class="m-doc">MyEnum</a>(enum.Enum): </span><span class="m-doc-wrap"><a href="#MyEnum-VALUE" class="m-doc">VALUE</a> = 0
<a href="#MyEnum-ANOTHER" class="m-doc">ANOTHER</a> = 1
<a href="#MyEnum-YAY" class="m-doc">YAY</a> = 2</span>
</dt>
<dd>An enum</dd>
<dt id="UndocumentedEnum">
<span class="m-doc-wrap-bumper">class <a href="#UndocumentedEnum" class="m-doc-self">UndocumentedEnum</a>(enum.IntFlag): </span><span class="m-doc-wrap"><a href="#UndocumentedEnum-FLAG_ONE" class="m-doc-self" id="UndocumentedEnum-FLAG_ONE">FLAG_ONE</a> = 1
<a href="#UndocumentedEnum-FLAG_SEVENTEEN" class="m-doc-self" id="UndocumentedEnum-FLAG_SEVENTEEN">FLAG_SEVENTEEN</a> = 17</span>
</dt>
<dd></dd>
</dl>
</section>
<section id="functions">
<h2><a href="#functions">Functions</a></h2>
<dl class="m-doc">
<dt id="function">
<span class="m-doc-wrap-bumper">def <a href="#function" class="m-doc-self">function</a>(</span><span class="m-doc-wrap">)</span>
</dt>
<dd>A function</dd>
</dl>
</section>
<section id="data">
<h2><a href="#data">Data</a></h2>
<dl class="m-doc">
<dt id="A_CONSTANT">
<a href="#A_CONSTANT" class="m-doc-self">A_CONSTANT</a> = 3.24
</dt>
<dd></dd>
<dt id="foo">
<a href="#foo" class="m-doc-self">foo</a>
</dt>
<dd></dd>
</dl>
</section>
<section>
<h2>Enum documentation</h2>
<section class="m-doc-details" id="MyEnum"><div>
<h3>
class inspect_string.<wbr /><a href="#MyEnum" class="m-doc-self">MyEnum</a>(enum.Enum)
</h3>
<p>An enum</p>
<table class="m-table m-fullwidth m-flat m-doc">
<thead><tr><th style="width: 1%">Enumerators</th><th></th></tr></thead>
<tbody>
<tr>
<td><a href="#MyEnum-VALUE" id="MyEnum-VALUE" class="m-doc-self">VALUE</a></td>
<td>
<p>A value</p>
</td>
</tr>
<tr>
<td><a href="#MyEnum-ANOTHER" id="MyEnum-ANOTHER" class="m-doc-self">ANOTHER</a></td>
<td>
<p>Another value</p>
</td>
</tr>
<tr>
<td><a href="#MyEnum-YAY" id="MyEnum-YAY" class="m-doc-self">YAY</a></td>
<td>
</td>
</tr>
</tbody>
</table>
</div></section>
</section>
</div>
</div>
</div>
</article></main>
</body>
</html>
|
