Skip to content

Commit 2eec7af

Browse files
abomabom
authored
bumb version to 11.0b13 and generate docs (#590)
* bumb version to 11.0b13 * regenerate docs
1 parent 0ce2bf3 commit 2eec7af

File tree

20 files changed

+1381
-1422
lines changed

20 files changed

+1381
-1422
lines changed

‎docs/api/jumpscale/clients/base.html

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -75,13 +75,12 @@ <h3>Ancestors</h3>
7575
</ul>
7676
<h3>Subclasses</h3>
7777
<ul class="hlist">
78-
<li><a title="jumpscale.clients.git.git.GitClient" href="git/git.html#jumpscale.clients.git.git.GitClient">GitClient</a></li>
79-
<li><a title="jumpscale.clients.zdb.client.ZDBClient" href="zdb/client.html#jumpscale.clients.zdb.client.ZDBClient">ZDBClient</a></li>
80-
<li><a title="jumpscale.clients.gedis.gedis.GedisClient" href="gedis/gedis.html#jumpscale.clients.gedis.gedis.GedisClient">GedisClient</a></li>
81-
<li><a title="jumpscale.clients.sshkey.sshkey.SSHKeyClient" href="sshkey/sshkey.html#jumpscale.clients.sshkey.sshkey.SSHKeyClient">SSHKeyClient</a></li>
8278
<li><a title="jumpscale.clients.docker.docker.DockerClient" href="docker/docker.html#jumpscale.clients.docker.docker.DockerClient">DockerClient</a></li>
83-
<li><a title="jumpscale.clients.sshclient.sshclient.SSHClient" href="sshclient/sshclient.html#jumpscale.clients.sshclient.sshclient.SSHClient">SSHClient</a></li>
79+
<li><a title="jumpscale.clients.zdb.client.ZDBClient" href="zdb/client.html#jumpscale.clients.zdb.client.ZDBClient">ZDBClient</a></li>
8480
<li><a title="jumpscale.clients.redis.redis.RedisClient" href="redis/redis.html#jumpscale.clients.redis.redis.RedisClient">RedisClient</a></li>
81+
<li><a title="jumpscale.clients.sshclient.sshclient.SSHClient" href="sshclient/sshclient.html#jumpscale.clients.sshclient.sshclient.SSHClient">SSHClient</a></li>
82+
<li><a title="jumpscale.clients.git.git.GitClient" href="git/git.html#jumpscale.clients.git.git.GitClient">GitClient</a></li>
83+
<li><a title="jumpscale.clients.sshkey.sshkey.SSHKeyClient" href="sshkey/sshkey.html#jumpscale.clients.sshkey.sshkey.SSHKeyClient">SSHKeyClient</a></li>
8584
</ul>
8685
<h3>Inherited members</h3>
8786
<ul class="hlist">
@@ -124,4 +123,4 @@ <h4><code><a title="jumpscale.clients.base.Client" href="#jumpscale.clients.base
124123
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
125124
<script>hljs.initHighlightingOnLoad()</script>
126125
</body>
127-
</html>
126+
</html>

‎docs/api/jumpscale/clients/index.html

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,6 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
3232
<dd>
3333
<section class="desc"></section>
3434
</dd>
35-
<dt><code class="name"><a title="jumpscale.clients.gedis" href="gedis/index.html">jumpscale.clients.gedis</a></code></dt>
36-
<dd>
37-
<section class="desc"><p>This module gives you all the facilities to communicate with gedis server …</p></section>
38-
</dd>
3935
<dt><code class="name"><a title="jumpscale.clients.git" href="git/index.html">jumpscale.clients.git</a></code></dt>
4036
<dd>
4137
<section class="desc"></section>
@@ -80,7 +76,6 @@ <h1>Index</h1>
8076
<ul>
8177
<li><code><a title="jumpscale.clients.base" href="base.html">jumpscale.clients.base</a></code></li>
8278
<li><code><a title="jumpscale.clients.docker" href="docker/index.html">jumpscale.clients.docker</a></code></li>
83-
<li><code><a title="jumpscale.clients.gedis" href="gedis/index.html">jumpscale.clients.gedis</a></code></li>
8479
<li><code><a title="jumpscale.clients.git" href="git/index.html">jumpscale.clients.git</a></code></li>
8580
<li><code><a title="jumpscale.clients.redis" href="redis/index.html">jumpscale.clients.redis</a></code></li>
8681
<li><code><a title="jumpscale.clients.sshclient" href="sshclient/index.html">jumpscale.clients.sshclient</a></code></li>

‎docs/api/jumpscale/core/base/fields.html

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1112,18 +1112,16 @@ <h1 class="title">Module <code>jumpscale.core.base.fields</code></h1>
11121112

11131113

11141114
class Json(String):
1115-
def __init__(self, default=&#34;{}&#34;, encoding=&#34;utf-8&#34;, **kwargs):
1115+
def __init__(self, default=&#34;{}&#34;, **kwargs):
11161116
&#34;&#34;&#34;
11171117
Json field, will check if the value is a valid json string.
11181118

11191119
It will hold json strings, if the value is not string, it will be converted.
11201120

11211121
Args:
11221122
default (str, optional): default value. Defaults to &#34;{}&#34;
1123-
encoding: encoding to be used when serializing the value. Defaults to &#34;utf-8&#34;
11241123
kwargs: other keyword arguments supported by `String`
11251124
&#34;&#34;&#34;
1126-
self.encoding = encoding
11271125
super().__init__(default=default, **kwargs)
11281126

11291127
def validate(self, value):
@@ -1143,7 +1141,7 @@ <h1 class="title">Module <code>jumpscale.core.base.fields</code></h1>
11431141

11441142
# if it&#39;s a string, try to load it
11451143
try:
1146-
json.loads(value, encoding=self.encoding)
1144+
json.loads(value)
11471145
except Exception as e:
11481146
raise ValidationError(f&#34;&#39;{value}&#39; isn&#39;t a valid json, {e}&#34;) from e
11491147

@@ -3255,7 +3253,7 @@ <h3>Inherited members</h3>
32553253
</dd>
32563254
<dt id="jumpscale.core.base.fields.Json"><code class="flex name class">
32573255
<span>class <span class="ident">Json</span></span>
3258-
<span>(</span><span>default='{}', encoding='utf-8', **kwargs)</span>
3256+
<span>(</span><span>default='{}', **kwargs)</span>
32593257
</code></dt>
32603258
<dd>
32613259
<section class="desc"><p>Json field, will check if the value is a valid json string.</p>
@@ -3264,26 +3262,22 @@ <h2 id="args">Args</h2>
32643262
<dl>
32653263
<dt><strong><code>default</code></strong> :&ensp;<code>str</code>, optional</dt>
32663264
<dd>default value. Defaults to "{}"</dd>
3267-
<dt><strong><code>encoding</code></strong></dt>
3268-
<dd>encoding to be used when serializing the value. Defaults to "utf-8"</dd>
32693265
<dt><strong><code>kwargs</code></strong></dt>
32703266
<dd>other keyword arguments supported by <a title="jumpscale.core.base.fields.String" href="#jumpscale.core.base.fields.String"><code>String</code></a></dd>
32713267
</dl></section>
32723268
<details class="source">
32733269
<summary>Source code</summary>
32743270
<pre><code class="python">class Json(String):
3275-
def __init__(self, default=&#34;{}&#34;, encoding=&#34;utf-8&#34;, **kwargs):
3271+
def __init__(self, default=&#34;{}&#34;, **kwargs):
32763272
&#34;&#34;&#34;
32773273
Json field, will check if the value is a valid json string.
32783274

32793275
It will hold json strings, if the value is not string, it will be converted.
32803276

32813277
Args:
32823278
default (str, optional): default value. Defaults to &#34;{}&#34;
3283-
encoding: encoding to be used when serializing the value. Defaults to &#34;utf-8&#34;
32843279
kwargs: other keyword arguments supported by `String`
32853280
&#34;&#34;&#34;
3286-
self.encoding = encoding
32873281
super().__init__(default=default, **kwargs)
32883282

32893283
def validate(self, value):
@@ -3303,7 +3297,7 @@ <h2 id="args">Args</h2>
33033297

33043298
# if it&#39;s a string, try to load it
33053299
try:
3306-
json.loads(value, encoding=self.encoding)
3300+
json.loads(value)
33073301
except Exception as e:
33083302
raise ValidationError(f&#34;&#39;{value}&#39; isn&#39;t a valid json, {e}&#34;) from e
33093303

@@ -3398,7 +3392,7 @@ <h2 id="raises">Raises</h2>
33983392

33993393
# if it&#39;s a string, try to load it
34003394
try:
3401-
json.loads(value, encoding=self.encoding)
3395+
json.loads(value)
34023396
except Exception as e:
34033397
raise ValidationError(f&#34;&#39;{value}&#39; isn&#39;t a valid json, {e}&#34;) from e</code></pre>
34043398
</details>

‎docs/api/jumpscale/core/base/meta.html

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1043,12 +1043,10 @@ <h3>Subclasses</h3>
10431043
<ul class="hlist">
10441044
<li><a title="jumpscale.tools.startupcmd.startupcmd.StartupCmd" href="../../tools/startupcmd/startupcmd.html#jumpscale.tools.startupcmd.startupcmd.StartupCmd">StartupCmd</a></li>
10451045
<li><a title="jumpscale.clients.base.Client" href="../../clients/base.html#jumpscale.clients.base.Client">Client</a></li>
1046-
<li><a title="jumpscale.servers.gedis.server.GedisServer" href="../../servers/gedis/server.html#jumpscale.servers.gedis.server.GedisServer">GedisServer</a></li>
1046+
<li><a title="jumpscale.servers.rack.rack.ServerRack" href="../../servers/rack/rack.html#jumpscale.servers.rack.rack.ServerRack">ServerRack</a></li>
10471047
<li><a title="jumpscale.servers.openresty.location.Location" href="../../servers/openresty/location.html#jumpscale.servers.openresty.location.Location">Location</a></li>
10481048
<li><a title="jumpscale.servers.openresty.server.Website" href="../../servers/openresty/server.html#jumpscale.servers.openresty.server.Website">Website</a></li>
10491049
<li><a title="jumpscale.servers.openresty.server.OpenRestyServer" href="../../servers/openresty/server.html#jumpscale.servers.openresty.server.OpenRestyServer">OpenRestyServer</a></li>
1050-
<li><a title="jumpscale.servers.rack.rack.ServerRack" href="../../servers/rack/rack.html#jumpscale.servers.rack.rack.ServerRack">ServerRack</a></li>
1051-
<li><a title="jumpscale.servers.gedis_http.GedisHTTPServer" href="../../servers/gedis_http/index.html#jumpscale.servers.gedis_http.GedisHTTPServer">GedisHTTPServer</a></li>
10521050
</ul>
10531051
<h3>Static methods</h3>
10541052
<dl>
@@ -1315,4 +1313,4 @@ <h4><code><a title="jumpscale.core.base.meta.BaseMeta" href="#jumpscale.core.bas
13151313
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
13161314
<script>hljs.initHighlightingOnLoad()</script>
13171315
</body>
1318-
</html>
1316+
</html>

‎docs/api/jumpscale/core/config/config.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,7 @@ <h2 id="getset">Get/Set</h2>
182182
&#34;debug&#34;: True,
183183
&#34;shell&#34;: &#34;ptpython&#34;,
184184
&#34;logging&#34;: {
185+
&#34;default&#34;: {&#34;enabled&#34;: True, &#34;level&#34;: 10,},
185186
&#34;redis&#34;: {
186187
&#34;enabled&#34;: True,
187188
&#34;level&#34;: 15,
@@ -431,6 +432,7 @@ <h2 id="returns">Returns</h2>
431432
&#34;debug&#34;: True,
432433
&#34;shell&#34;: &#34;ptpython&#34;,
433434
&#34;logging&#34;: {
435+
&#34;default&#34;: {&#34;enabled&#34;: True, &#34;level&#34;: 10,},
434436
&#34;redis&#34;: {
435437
&#34;enabled&#34;: True,
436438
&#34;level&#34;: 15,

‎docs/api/jumpscale/core/executors/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
3636
</dd>
3737
<dt><code class="name"><a title="jumpscale.core.executors.local" href="local.html">jumpscale.core.executors.local</a></code></dt>
3838
<dd>
39-
<section class="desc"><p>Executor Local allows executing commands within specific env on the local machine. using the executor framework you can retrieve the stdout, stderr, …</p></section>
39+
<section class="desc"><p>Local executor allows executing commands within specific env on the local machine. using the executor framework you can retrieve the stdout, stderr, …</p></section>
4040
</dd>
4141
<dt><code class="name"><a title="jumpscale.core.executors.remote" href="remote.html">jumpscale.core.executors.remote</a></code></dt>
4242
<dd>
43-
<section class="desc"><p>Executor remote allows executing commands within specific env on the local machine. using the executor framework you can retrieve the stdout, stderr, …</p></section>
43+
<section class="desc"><p>Remote executor allows executing commands within specific env on any machine. using the executor framework you can retrieve the stdout, stderr, and …</p></section>
4444
</dd>
4545
<dt><code class="name"><a title="jumpscale.core.executors.tmux" href="tmux.html">jumpscale.core.executors.tmux</a></code></dt>
4646
<dd>

0 commit comments

Comments
 (0)