-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
308 lines (276 loc) · 15.4 KB
/
index.html
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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>HappyPanda X user guide — HappyPanda X 0.13.3#170 documentation</title>
<link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/style.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script src="https://platform.twitter.com/widgets.js"></script>
<script src="_static/script.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Installing" href="install.html" />
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
<script type="text/javascript" src="_static/js/jquery-1.11.0.min.js "></script>
<script type="text/javascript" src="_static/js/jquery-fix.js "></script>
<script type="text/javascript" src="_static/bootstrap-3.3.7/js/bootstrap.min.js "></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js "></script>
</head><body>
<div id="navbar" class="navbar navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="#"><span><img src="_static/hpx_logo.svg"></span>
HappyPanda X</a>
<span class="navbar-text navbar-version pull-left"><b>0.13.3#170</b></span>
</div>
<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
<li class="dropdown globaltoc-container">
<a role="button"
id="dLabelGlobalToc"
data-toggle="dropdown"
data-target="#"
href="#">Contents <b class="caret"></b></a>
<ul class="dropdown-menu globaltoc"
role="menu"
aria-labelledby="dLabelGlobalToc"><ul>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installing</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Using HappyPanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage.html#installing-plugins">Installing plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage.html#securing-happypanda-x">Securing HappyPanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage.html#exposing-happypanda-x">Exposing HappyPanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="translation.html">Translations</a></li>
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="switches.html">Command-Line Arguments</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="env.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="env.html#editing-the-documentation">Editing the documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="client.html">Creating frontends</a></li>
<li class="toctree-l1"><a class="reference internal" href="plugin.html">Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="todo.html">TODO</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api_general.html">General</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html">Server API</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_plugin.html">Plugin API</a></li>
</ul>
</ul>
</li>
<li>
<a href="install.html" title="Next Chapter: Installing"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">Installing »</span>
</a>
</li>
</ul>
<form class="navbar-form navbar-right" action="search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
</div>
<ul class="quick-links">
<li>
<strong>Quick links</strong>
</li>
<li class="quick-link">
<a class="github-button" href="https://github.com/twiddli" aria-label="Follow @twiddli on GitHub">Follow @twiddli</a>
</li>
<li class="quick-link">
<a class="github-button" href="https://github.com/happypandax/happypandax/issues" data-icon="octicon-issue-opened" data-show-count="true" aria-label="Issue happypandax/happypandax on GitHub">Issue</a>
</li>
<li class="divider">·</li>
<li class="quick-link">
<a class="github-button" href="https://github.com/happypandax/happypandax" data-icon="octicon-star" data-show-count="true" aria-label="Star happypandax/happypandax on GitHub">Star</a>
</li>
<li class="quick-link">
<a class="github-button" href="https://github.com/happypandax/happypandax/fork" data-icon="octicon-repo-forked" data-show-count="true" aria-label="Fork happypandax/happypandax on GitHub">Fork</a>
</li>
<li class="divider">·</li>
<li class="quick-link">
<a href="https://twitter.com/twiddly_"
class="twitter-follow-button" data-width="145px"
data-link-color="#0069D6" data-show-count="false">
Follow
@twiddly_
</a>
</li>
<li class="quick-link">
<a href="https://twitter.com/share" class="twitter-share-button"
data-url="" data-count="horizontal"
data-via="twbootstrap"
data-related="twiddly_:Creator of HappyPanda X">Tweet</a>
</li>
</ul>
<div class="container">
<div class="row">
<div class="col-md-3">
<div id="sidebar" class="bs-sidenav" role="complementary"><ul>
<li><a class="reference internal" href="#">HappyPanda X user guide</a></li>
<li><a class="reference internal" href="#for-developers">For developers</a><ul>
<li><a class="reference internal" href="#developer-api">Developer API</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="col-md-9 content">
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This is project is under heavy development.
If you want to speed up the development, please consider <a class="reference internal" href="env.html#contributing"><span class="std std-ref">Contributing</span></a>.</p>
</div>
<div class="section" id="happypanda-x-user-guide">
<h1>HappyPanda X user guide<a class="headerlink" href="#happypanda-x-user-guide" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install.html#docker">Docker</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Using HappyPanda X</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage.html#setting-up">Setting up</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#starting">Starting</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#migrating-from-happypanda">Migrating from HappyPanda</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#using">Using</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="usage.html#installing-plugins">Installing plugins</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage.html#be-careful-about-plugins">Be careful about plugins</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="usage.html#securing-happypanda-x">Securing HappyPanda X</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage.html#users">Users</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#tls-ssl-support">TLS/SSL Support</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="usage.html#exposing-happypanda-x">Exposing HappyPanda X</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage.html#private-network">Private network</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#public-network">Public network</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#reverse-proxy">Reverse Proxy</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="translation.html">Translations</a><ul>
<li class="toctree-l2"><a class="reference internal" href="translation.html#translator-s-perspective">Translator’s perspective</a></li>
<li class="toctree-l2"><a class="reference internal" href="translation.html#developer-s-perspective">Developer’s perspective</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="switches.html">Command-Line Arguments</a><ul>
<li class="toctree-l2"><a class="reference internal" href="switches.html#command-line-arguments-user">Command-Line Arguments user</a></li>
<li class="toctree-l2"><a class="reference internal" href="switches.html#command-line-arguments-user-create">Command-Line Arguments user create</a></li>
<li class="toctree-l2"><a class="reference internal" href="switches.html#command-line-arguments-user-delete">Command-Line Arguments user delete</a></li>
<li class="toctree-l2"><a class="reference internal" href="switches.html#command-line-arguments-user-list">Command-Line Arguments user list</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a><ul>
<li class="toctree-l2"><a class="reference internal" href="faq.html#file-support">File Support</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#scanning-for-galleries">Scanning for galleries</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="for-developers">
<h1>For developers<a class="headerlink" href="#for-developers" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="env.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="env.html#editing-the-documentation">Editing the documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="client.html">Creating frontends</a><ul>
<li class="toctree-l2"><a class="reference internal" href="client.html#client-libraries">Client libraries</a></li>
<li class="toctree-l2"><a class="reference internal" href="client.html#exchanging-messages">Exchanging messages</a></li>
<li class="toctree-l2"><a class="reference internal" href="client.html#authenticating">Authenticating</a></li>
<li class="toctree-l2"><a class="reference internal" href="client.html#session">Session</a></li>
<li class="toctree-l2"><a class="reference internal" href="client.html#calling-a-function">Calling a function</a></li>
<li class="toctree-l2"><a class="reference internal" href="client.html#errors">Errors</a></li>
<li class="toctree-l2"><a class="reference internal" href="client.html#server-commands">Server commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="client.html#playing-with-the-api">Playing with the API</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="plugin.html">Plugins</a><ul>
<li class="toctree-l2"><a class="reference internal" href="plugin.html#terminology">Terminology</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin.html#defining-a-plugin">Defining a plugin</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin.html#writing-a-plugin">Writing a plugin</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin.html#available-packages">Available packages</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="todo.html">TODO</a></li>
</ul>
</div>
<div class="section" id="developer-api">
<h2>Developer API<a class="headerlink" href="#developer-api" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="api_general.html">General</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api_general.html#asynchronous-commands">Asynchronous Commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="api_general.html#module-happypanda.interface.enums">Enums</a></li>
<li class="toctree-l2"><a class="reference internal" href="api_general.html#module-happypanda.common.exceptions">Exceptions</a></li>
<li class="toctree-l2"><a class="reference internal" href="api_general.html#guidelines">Guidelines</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api.html">Server API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api.html#summary">Summary</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#module-happypanda.interface.meta">Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api_plugin.html">Plugin API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api_plugin.html#interface">Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="api_plugin.html#special-commands">Special Commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="api_plugin.html#summary">Summary</a></li>
<li class="toctree-l2"><a class="reference internal" href="api_plugin.html#module-happypanda.core.commands.meta_cmd">Commands</a></li>
</ul>
</li>
</ul>
</div>
<p>I’m available at <a class="reference external" href="https://gitter.im/Pewpews/happypandax">Gitter</a> for any help concerning HPX.</p>
</div>
</div>
</div>
</div>
<div class="row">
<script src="https://utteranc.es/client.js"
repo="happypandax/happypandax.github.io"
issue-term="pathname"
label="💬 docs"
theme="github-light"
crossorigin="anonymous"
async>
</script>
</div>
</div>
<script async defer src="https://buttons.github.io/buttons.js"></script>
<footer class="footer">
<div class="container">
<p class="pull-right">
<a href="#">Back to top</a>
<br/>
</p>
<p>
© Copyright Twiddly.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.2.1.<br/>
</p>
</div>
</footer>
</body>
</html>