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/index.html
+96 -145
View File
@@ -85,7 +85,7 @@
<li class="header">Intro</li>
<li class="header">Packages</li>
@@ -102,14 +102,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/">
@@ -120,14 +113,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>
@@ -135,7 +129,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/">
@@ -146,9 +145,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 " data-level="2.4" data-path="api-rx/">
<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 " data-level="1.4" data-path="api-rx/">
<a href="api-rx/">
@@ -159,14 +190,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="api-rx/classes/_index_.rxapi.html">
<a href="type-extrinsics/">
<a href="api-rx/classes/_index_.rxapi.html">
type-extrinsics
ApiRx
</a>
@@ -174,55 +206,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>
@@ -233,7 +218,7 @@
<li class="chapter " data-level="3.1" data-path="examples/">
<li class="chapter " data-level="2.1" data-path="examples/">
<a href="examples/">
@@ -246,7 +231,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/">
@@ -259,7 +244,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/">
@@ -272,7 +257,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/">
@@ -285,7 +270,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/">
@@ -298,7 +283,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/">
@@ -311,7 +296,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/">
@@ -324,7 +309,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/">
@@ -339,26 +324,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>
@@ -403,61 +368,47 @@
<section class="normal markdown-section">
<h1 id="polkadot-javascript-api">Polkadot Javascript API</h1>
<div id="toc" class="toc">
<div id="toctitle">Table of Contents</div>
<ul class="sectlevel1">
<li><a href="#_the_polkadot_project">The Polkadot Project</a></li>
<li><a href="#_github_repositories">Github repositories</a></li>
<li><a href="#_contributing">Contributing</a></li>
</ul>
</div>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>You can query a node and interact with the Polkadot network using Javascript. This guide describes the Polkadot Javascript API.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_the_polkadot_project">The Polkadot Project</h2>
<div class="sectionbody">
<div class="paragraph">
<p>You can read more about the Polkadot Network at <a href="https://polkadot.network/" class="bare" target="_blank">https://polkadot.network/</a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_github_repositories">Github repositories</h2>
<div class="sectionbody">
<div class="paragraph">
<p>You can find the Polkadot repositories at:</p>
</div>
<div class="ulist">
<h2 id="packages">Packages</h2>
<ul>
<li>
<p><a href="https://github.com/polkadot-js" class="bare" target="_blank">https://github.com/polkadot-js</a></p>
<li><a href="api/">api</a><ul>
<li><a href="api/classes/_index_.api.html">Api</a></li>
</ul>
</li>
<li>
<p><a href="https://github.com/paritytech/polkadot" class="bare" target="_blank">https://github.com/paritytech/polkadot</a></p>
<li><a href="api-provider/">api-provider</a><ul>
<li><a href="api-provider/classes/_http_index_.httpprovider.html">HttpProvider</a></li>
<li><a href="api-provider/classes/_ws_index_.wsprovider.html">WsProvider</a></li>
</ul>
</li>
<li>
<p><a href="https://github.com/paritytech/substrate" class="bare" target="_blank">https://github.com/paritytech/substrate</a></p>
<li><a href="api-rx/">api-rx</a><ul>
<li><a href="api-rx/classes/_index_.rxapi.html">ApiRx</a></li>
</ul>
</li>
</ul>
</div>
<div class="paragraph">
<p>This documentation is generated from <a href="https://github.com/polkadot-js/api" class="bare" target="_blank">https://github.com/polkadot-js/api</a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_contributing">Contributing</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Contribution to the Polkadot JS API are more than welcome. You can <a href="https://github.com/polkadot-js/api/issues/new" target="_blank">report issues</a> and <a href="https://github.com/polkadot-js/api/issues/new" target="_blank">feature requests</a>.</p>
</div>
</div>
</div>
<h2 id="examples">Examples</h2>
<ul>
<li><a href="examples/">Overview</a></li>
<li><a href="examples/01_simple_connect/">Simple connect</a></li>
<li><a href="examples/02_listen_to_blocks/">Listen to blocks</a></li>
<li><a href="examples/03_listen_to_balance_change/">Listen to balance change</a></li>
<li><a href="examples/04_generate_account/">Generate Accounts</a></li>
<li><a href="examples/05_read_storage/">Read Storage</a></li>
<li><a href="examples/06_craft_extrinsic/">Craft Extrinsic</a></li>
<li><a href="examples/07_transfer_dots/">Transfer DOTs</a></li>
</ul>
<h2 id="the-polkadot-project">The Polkadot Project</h2>
<p>You can read more about the Polkadot Network at <a href="https://polkadot.network/" target="_blank">https://polkadot.network/</a></p>
<h2 id="github-repositories">Github repositories</h2>
<p>You can find the Polkadot repositories at:</p>
<ul>
<li><a href="https://github.com/polkadot-js" target="_blank">https://github.com/polkadot-js</a></li>
<li><a href="https://github.com/paritytech/polkadot" target="_blank">https://github.com/paritytech/polkadot</a></li>
<li><a href="https://github.com/paritytech/substrate" target="_blank">https://github.com/paritytech/substrate</a></li>
</ul>
<p>This documentation is generated from <a href="https://github.com/polkadot-js/api" target="_blank">https://github.com/polkadot-js/api</a></p>
<h2 id="contributing">Contributing</h2>
<p>Contribution to the Polkadot JS API are more than welcome. You can <a href="https://github.com/polkadot-js/api/issues/new" target="_blank">report issues</a> and <a href="https://github.com/polkadot-js/api/issues/new" target="_blank">log feature requests</a>.</p>
</section>
@@ -496,7 +447,7 @@
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"api","level":"2.1","depth":1,"path":"api/README.md","ref":"api/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":"README.adoc","mtime":"2018-09-17T12:30:32.109Z","type":"asciidoc"},"gitbook":{"version":"3.2.3","time":"2018-09-17T12:37:27.221Z"},"basePath":".","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"api","level":"1.2","depth":1,"path":"api/README.md","ref":"api/README.md","articles":[{"title":"Api","level":"1.2.1","depth":2,"path":"api/classes/_index_.api.md","ref":"api/classes/_index_.api.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":"README.md","mtime":"2018-09-19T10:15:30.638Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-09-19T11:17:59.884Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>