quantus/api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Gitbook rendering updates (#159)

Browse Source 
* Add .nodoc for in-flux packages

* Start with clean-slate for re-generation

* Update with working (although manual) config
This commit is contained in:
Jaco Greeff
2018-09-19 16:14:37 +02:00
committed by GitHub
parent ef78f2a024
commit 4854379424
108 changed files with 5067 additions and 12149 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api-rx/index.html
+65 -148
View File
@@ -57,10 +57,10 @@
<link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon">
<link rel="next" href="../type-extrinsics/" />
<link rel="next" href="classes/_index_.rxapi.html" />
<link rel="prev" href="../api-provider/" />
<link rel="prev" href="../api-provider/classes/_ws_index_.wsprovider.html" />
</head>
@@ -87,7 +87,7 @@
<li class="header">Intro</li>
<li class="header">Packages</li>
@@ -104,14 +104,7 @@
</li>
<li class="header">API</li>
<li class="chapter " data-level="2.1" data-path="../api/">
<li class="chapter " data-level="1.2" data-path="../api/">
<a href="../api/">
@@ -122,14 +115,15 @@
</li>
<ul class="articles">
<li class="chapter " data-level="2.2" data-path="../api-format/">
<li class="chapter " data-level="1.2.1" data-path="../api/classes/_index_.api.html">
<a href="../api-format/">
<a href="../api/classes/_index_.api.html">
api-format
Api
</a>
@@ -137,7 +131,12 @@
</li>
<li class="chapter " data-level="2.3" data-path="../api-provider/">
</ul>
</li>
<li class="chapter " data-level="1.3" data-path="../api-provider/">
<a href="../api-provider/">
@@ -148,9 +147,41 @@
<ul class="articles">
<li class="chapter " data-level="1.3.1" data-path="../api-provider/classes/_http_index_.httpprovider.html">
<a href="../api-provider/classes/_http_index_.httpprovider.html">
HttpProvider
</a>
</li>
<li class="chapter active" data-level="2.4" data-path="./">
<li class="chapter " data-level="1.3.2" data-path="../api-provider/classes/_ws_index_.wsprovider.html">
<a href="../api-provider/classes/_ws_index_.wsprovider.html">
WsProvider
</a>
</li>
</ul>
</li>
<li class="chapter active" data-level="1.4" data-path="./">
<a href="./">
@@ -161,14 +192,15 @@
</li>
<ul class="articles">
<li class="chapter " data-level="2.5" data-path="../type-extrinsics/">
<li class="chapter " data-level="1.4.1" data-path="classes/_index_.rxapi.html">
<a href="../type-extrinsics/">
<a href="classes/_index_.rxapi.html">
type-extrinsics
ApiRx
</a>
@@ -176,55 +208,8 @@
</li>
<li class="chapter " data-level="2.6" data-path="../type-jsonrpc/">
<a href="../type-jsonrpc/">
type-jsonrpc
</a>
</li>
<li class="chapter " data-level="2.7" data-path="../type-params/">
<a href="../type-params/">
type-params
</a>
</li>
<li class="chapter " data-level="2.8" data-path="../type-primitives/">
<a href="../type-primitives/">
type-primitives
</a>
</li>
<li class="chapter " data-level="2.9" data-path="../type-storage/">
<a href="../type-storage/">
type-storage
</a>
</ul>
</li>
@@ -235,7 +220,7 @@
<li class="chapter " data-level="3.1" data-path="../examples/">
<li class="chapter " data-level="2.1" data-path="../examples/">
<a href="../examples/">
@@ -248,7 +233,7 @@
</li>
<li class="chapter " data-level="3.2" data-path="../examples/01_simple_connect/">
<li class="chapter " data-level="2.2" data-path="../examples/01_simple_connect/">
<a href="../examples/01_simple_connect/">
@@ -261,7 +246,7 @@
</li>
<li class="chapter " data-level="3.3" data-path="../examples/02_listen_to_blocks/">
<li class="chapter " data-level="2.3" data-path="../examples/02_listen_to_blocks/">
<a href="../examples/02_listen_to_blocks/">
@@ -274,7 +259,7 @@
</li>
<li class="chapter " data-level="3.4" data-path="../examples/03_listen_to_balance_change/">
<li class="chapter " data-level="2.4" data-path="../examples/03_listen_to_balance_change/">
<a href="../examples/03_listen_to_balance_change/">
@@ -287,7 +272,7 @@
</li>
<li class="chapter " data-level="3.5" data-path="../examples/04_generate_account/">
<li class="chapter " data-level="2.5" data-path="../examples/04_generate_account/">
<a href="../examples/04_generate_account/">
@@ -300,7 +285,7 @@
</li>
<li class="chapter " data-level="3.6" data-path="../examples/05_read_storage/">
<li class="chapter " data-level="2.6" data-path="../examples/05_read_storage/">
<a href="../examples/05_read_storage/">
@@ -313,7 +298,7 @@
</li>
<li class="chapter " data-level="3.7" data-path="../examples/06_craft_extrinsic/">
<li class="chapter " data-level="2.7" data-path="../examples/06_craft_extrinsic/">
<a href="../examples/06_craft_extrinsic/">
@@ -326,7 +311,7 @@
</li>
<li class="chapter " data-level="3.8" data-path="../examples/07_transfer_dots/">
<li class="chapter " data-level="2.8" data-path="../examples/07_transfer_dots/">
<a href="../examples/07_transfer_dots/">
@@ -341,26 +326,6 @@
<li class="header">Contributing</li>
<li class="chapter " data-level="4.1" data-path="../CONTRIBUTING.html">
<a href="../CONTRIBUTING.html">
Contributing guide
</a>
</li>
<li class="divider"></li>
@@ -407,54 +372,6 @@
<p><a href="https://polkadot.js.org" target="_blank"><img src="https://img.shields.io/badge/polkadot-js-orange.svg?style=flat-square" alt="polkadotjs"></a> <img src="https://img.shields.io/badge/license-ISC-lightgrey.svg?style=flat-square" alt="isc"> <a href="https://github.com/Flet/semistandard" target="_blank"><img src="https://img.shields.io/badge/code%20style-semistandard-lightgrey.svg?style=flat-square" alt="style"></a> <a href="https://www.npmjs.com/package/@polkadot/api-rx" target="_blank"><img src="https://img.shields.io/npm/v/@polkadot/api-rx.svg?style=flat-square" alt="npm"></a> <a href="https://travis-ci.org/polkadot-js/api" target="_blank"><img src="https://img.shields.io/travis/polkadot-js/api.svg?style=flat-square" alt="travis"></a> <a href="https://codeclimate.com/github/polkadot-js/api/maintainability" target="_blank"><img src="https://img.shields.io/codeclimate/maintainability/polkadot-js/api.svg?style=flat-square" alt="maintainability"></a> <a href="https://coveralls.io/github/polkadot-js/api?branch=master" target="_blank"><img src="https://img.shields.io/coveralls/polkadot-js/api.svg?style=flat-square" alt="coverage"></a> <a href="https://david-dm.org/polkadot-js/api?path=packages/api-rx" target="_blank"><img src="https://david-dm.org/polkadot-js/api.svg?style=flat-square&amp;path=packages/api-rx" alt="dependency"></a> <a href="https://david-dm.org/polkadot-js/api?path=packages/api-rx#info=devDependencies" target="_blank"><img src="https://david-dm.org/polkadot-js/api/dev-status.svg?style=flat-square&amp;path=packages/api-rx" alt="devDependency"></a></p>
<h1 id="polkadotapi-rx">@polkadot/api-rx</h1>
<p>An RxJs wrapper around the <a href="../api">@polkadot/api</a>.</p>
<h2 id="index">Index</h2>
<h3 id="classes">Classes</h3>
<ul>
<li><a href="classes/rxapi.md">RxApi</a></li>
</ul>
<h3 id="type-aliases">Type aliases</h3>
<ul>
<li><a href="#rxapiinterface">RxApiInterface</a></li>
<li><a href="#rxapiinterface_method">RxApiInterface$Method</a></li>
<li><a href="#rxapiinterface_section">RxApiInterface$Section</a></li>
</ul>
<hr>
<h2 id="type-aliases">Type aliases</h2>
<p><a id="rxapiinterface"></a></p>
<h3 id="rxapiinterface">RxApiInterface</h3>
<p><strong>&#x1AC; RxApiInterface</strong>: <em> <code>RxApiInterface$Keys</code> &amp; <code>object</code>
</em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-rx/src/types.d.ts#L19" target="_blank">types.d.ts:19</a></em></p>
<hr>
<p><a id="rxapiinterface_method"></a></p>
<h3 id="rxapiinterfacemethod">RxApiInterface$Method</h3>
<p><strong>&#x1AC; RxApiInterface$Method</strong>: <em><code>function</code></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-rx/src/types.d.ts#L9" target="_blank">types.d.ts:9</a></em></p>
<h4 id="type-declaration">Type declaration</h4>
<p>&#x25B8;(...params: <em><code>Array</code>&lt;<code>any</code>&gt;</em>): <code>Observable</code>&lt;<code>any</code>&gt; | <code>BehaviorSubject</code>&lt;<code>any</code>&gt;</p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
<th>Param</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>Rest</code> params</td>
<td><code>Array</code>&lt;<code>any</code>&gt;</td>
</tr>
</tbody>
</table>
<p><strong>Returns:</strong> <code>Observable</code>&lt;<code>any</code>&gt; | <code>BehaviorSubject</code>&lt;<code>any</code>&gt;</p>
<hr>
<p><a id="rxapiinterface_section"></a></p>
<h3 id="rxapiinterfacesection">RxApiInterface$Section</h3>
<p><strong>&#x1AC; RxApiInterface$Section</strong>: <em><code>object</code></em></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-rx/src/types.d.ts#L11" target="_blank">types.d.ts:11</a></em></p>
<h4 id="type-declaration">Type declaration</h4>
<hr>
</section>
@@ -482,12 +399,12 @@
<a href="../api-provider/" class="navigation navigation-prev " aria-label="Previous page: api-provider">
<a href="../api-provider/classes/_ws_index_.wsprovider.html" class="navigation navigation-prev " aria-label="Previous page: WsProvider">
<i class="fa fa-angle-left"></i>
</a>
<a href="../type-extrinsics/" class="navigation navigation-next " aria-label="Next page: type-extrinsics">
<a href="classes/_index_.rxapi.html" class="navigation navigation-next " aria-label="Next page: ApiRx">
<i class="fa fa-angle-right"></i>
</a>
@@ -498,7 +415,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"api-rx","level":"2.4","depth":1,"next":{"title":"type-extrinsics","level":"2.5","depth":1,"path":"type-extrinsics/README.md","ref":"type-extrinsics/README.md","articles":[]},"previous":{"title":"api-provider","level":"2.3","depth":1,"path":"api-provider/README.md","ref":"api-provider/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["asciidoc-include"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"asciidoc-include":{"syntax":"asciidoc"},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api-rx/README.md","mtime":"2018-09-17T12:36:09.858Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-09-17T12:37:27.221Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"api-rx","level":"1.4","depth":1,"next":{"title":"ApiRx","level":"1.4.1","depth":2,"path":"api-rx/classes/_index_.rxapi.md","ref":"api-rx/classes/_index_.rxapi.md","articles":[]},"previous":{"title":"WsProvider","level":"1.3.2","depth":2,"path":"api-provider/classes/_ws_index_.wsprovider.md","ref":"api-provider/classes/_ws_index_.wsprovider.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api-rx/README.md","mtime":"2018-09-19T11:17:57.409Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-09-19T11:17:59.884Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>