docs: regenerate crystal documentation (#15)

q9f · Sep 29, 2021 · 4f1e975 · 4f1e975
1 parent 3e47b91
commit 4f1e975
Show file tree

Hide file tree

Showing 8 changed files with 351 additions and 242 deletions.
diff --git a/docs/Rlp.html b/docs/Rlp.html
@@ -3,54 +3,65 @@
 <head>
   <meta charset="utf-8" />
 <meta http-equiv="X-UA-Compatible" content="IE=edge">
-<meta name="generator" content="Crystal Docs 0.32.0">
+<meta name="generator" content="Crystal Docs 1.1.0">
+<meta name="crystal_docs.project_version" content="0.1.7-dev">
+<meta name="crystal_docs.project_name" content="rlp">
+
+
 
 <link href="css/style.css" rel="stylesheet" type="text/css" />
 <script type="text/javascript" src="js/doc.js"></script>
 
-<svg class="hidden">
-  <symbol id="octicon-link" viewBox="0 0 16 16">
-    <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
-  </symbol>
-</svg>
-
-  <meta id="repository-name" content="github.com/q9f/rlp.cr">
-  <title>Rlp - github.com/q9f/rlp.cr</title>
+  <meta name="repository-name" content="rlp">
+  <title>Rlp - rlp 0.1.7-dev</title>
   <script type="text/javascript">
-    CrystalDoc.base_path = "";
+    CrystalDocs.base_path = "";
   </script>
 </head>
 <body>
 
+<svg class="hidden">
+  <symbol id="octicon-link" viewBox="0 0 16 16">
+    <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
+  </symbol>
+</svg>
 <div class="sidebar">
   <div class="sidebar-header">
     <div class="search-box">
       <input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
     </div>
 
-    <div class="repository-links">
-      <a href="index.html">README</a>
+    <div class="project-summary">
+      <h1 class="project-name">
+        <a href="index.html">
+          rlp
+        </a>
+      </h1>
+
+      <span class="project-version">
+        0.1.7-dev
+      </span>
     </div>
   </div>
 
-  <div class="search-results" class="hidden">
+  <div class="search-results hidden">
     <ul class="search-list"></ul>
   </div>
 
   <div class="types-list">
     <ul>
 
-  <li class="parent open current" data-id="github.com/q9f/rlp.cr/Rlp" data-name="rlp">
+  <li class="parent open current" data-id="rlp/Rlp" data-name="rlp">
       <a href="Rlp.html">Rlp</a>
 
         <ul>
 
-  <li class=" " data-id="github.com/q9f/rlp.cr/Rlp/RecursiveArray" data-name="rlp::recursivearray">
+  <li class=" " data-id="rlp/Rlp/RecursiveArray" data-name="rlp::recursivearray">
       <a href="Rlp/RecursiveArray.html">RecursiveArray</a>
 
     </li>
 
-  <li class=" " data-id="github.com/q9f/rlp.cr/Rlp/Util" data-name="rlp::util">
+  <li class=" " data-id="rlp/Rlp/Util" data-name="rlp::util">
       <a href="Rlp/Util.html">Util</a>
 
     </li>
@@ -112,30 +123,22 @@ <h2>
   </h2>
 
 
-      <a href="https://github.com/q9f/rlp.cr/blob/5a44229dd0d4942943a70aaecb7e729013a91a97/src/array.cr#L17" target="_blank">
-        array.cr
-      </a>
+      array.cr
 
     <br/>
 
 
-      <a href="https://github.com/q9f/rlp.cr/blob/5a44229dd0d4942943a70aaecb7e729013a91a97/src/constants.cr#L17" target="_blank">
-        constants.cr
-      </a>
+      constants.cr
 
     <br/>
 
 
-      <a href="https://github.com/q9f/rlp.cr/blob/5a44229dd0d4942943a70aaecb7e729013a91a97/src/rlp.cr#L23" target="_blank">
-        rlp.cr
-      </a>
+      rlp.cr
 
     <br/>
 
 
-      <a href="https://github.com/q9f/rlp.cr/blob/5a44229dd0d4942943a70aaecb7e729013a91a97/src/version.cr#L17" target="_blank">
-        version.cr
-      </a>
+      version.cr
 
     <br/>
 
@@ -209,7 +212,7 @@ <h2>
 
 
       <dt class="entry-const" id="VERSION">
-        <strong>VERSION</strong> = <code><span class="s">&quot;0.1.2&quot;</span></code>
+        <strong>VERSION</strong> = <code><span class="s">&quot;0.1.8&quot;</span></code>
       </dt>
 
       <dd class="entry-const-doc">
@@ -330,7 +333,7 @@ <h2>
 
 <ul><li><code>rlp</code> (<code>Bytes</code>): the encoded <code><a href="Rlp.html">Rlp</a></code> data to decode.</li></ul>
 
-<pre><code><span class="t">Rlp</span>.decode <span class="t">Bytes</span>[<span class="n">195</span>, <span class="n">193</span>, <span class="n">192</span>, <span class="n">192</span>]
+<pre><code class="language-crystal"><span class="t">Rlp</span>.decode <span class="t">Bytes</span>[<span class="n">195</span>, <span class="n">193</span>, <span class="n">192</span>, <span class="n">192</span>]
 <span class="c"># =&gt; [[[]], []]</span></code></pre>
 
 <p><span class="flag purple">NOTE</span>  The returned data only restores the data structure.
@@ -341,8 +344,6 @@ <h2>
       <br/>
       <div>
 
-          [<a href="https://github.com/q9f/rlp.cr/blob/5a44229dd0d4942943a70aaecb7e729013a91a97/src/rlp.cr#L233" target="_blank">View source</a>]
-
       </div>
     </div>
 
@@ -363,7 +364,7 @@ <h2>
 
 <ul><li><code>hex</code> (<code>String</code>): the encoded <code><a href="Rlp.html">Rlp</a></code> data to decode.</li></ul>
 
-<pre><code><span class="t">Rlp</span>.decode <span class="s">&quot;c7c0c1c0c3c0c1c0&quot;</span>
+<pre><code class="language-crystal"><span class="t">Rlp</span>.decode <span class="s">&quot;c7c0c1c0c3c0c1c0&quot;</span>
 <span class="c"># =&gt; [[], [[]], [[], [[]]]]</span></code></pre>
 
 <p><span class="flag purple">NOTE</span>  The returned data only restores the data structure.
@@ -374,8 +375,6 @@ <h2>
       <br/>
       <div>
 
-          [<a href="https://github.com/q9f/rlp.cr/blob/5a44229dd0d4942943a70aaecb7e729013a91a97/src/rlp.cr#L326" target="_blank">View source</a>]
-
       </div>
     </div>
 
@@ -395,15 +394,13 @@ <h2>
 
 <ul><li><code>b</code> (<code>Bytes</code>): the binary <code>Bytes</code> data to encode.</li></ul>
 
-<pre><code><span class="t">Rlp</span>.encode <span class="t">Bytes</span>[<span class="n">15</span>, <span class="n">66</span>, <span class="n">64</span>]
+<pre><code class="language-crystal"><span class="t">Rlp</span>.encode <span class="t">Bytes</span>[<span class="n">15</span>, <span class="n">66</span>, <span class="n">64</span>]
 <span class="c"># =&gt; Bytes[131, 15, 66, 64]</span></code></pre>
         </div>
 
       <br/>
       <div>
 
-          [<a href="https://github.com/q9f/rlp.cr/blob/5a44229dd0d4942943a70aaecb7e729013a91a97/src/rlp.cr#L33" target="_blank">View source</a>]
-
       </div>
     </div>
 
@@ -423,15 +420,13 @@ <h2>
 
 <ul><li><code>l</code> (<code>Array</code>): the nested <code>Array</code> data to encode.</li></ul>
 
-<pre><code><span class="t">Rlp</span>.encode [[<span class="s">&quot;&quot;</span>], [<span class="s">&quot;&quot;</span>]]
+<pre><code class="language-crystal"><span class="t">Rlp</span>.encode [[<span class="s">&quot;&quot;</span>], [<span class="s">&quot;&quot;</span>]]
 <span class="c"># =&gt; Bytes[196, 193, 128, 193, 128]</span></code></pre>
         </div>
 
       <br/>
       <div>
 
-          [<a href="https://github.com/q9f/rlp.cr/blob/5a44229dd0d4942943a70aaecb7e729013a91a97/src/rlp.cr#L87" target="_blank">View source</a>]
-
       </div>
     </div>
 
@@ -451,15 +446,13 @@ <h2>
 
 <ul><li><code>s</code> (<code>String</code>): the <code>String</code> literal to encode.</li></ul>
 
-<pre><code><span class="t">Rlp</span>.encode <span class="s">&quot;dog&quot;</span>
+<pre><code class="language-crystal"><span class="t">Rlp</span>.encode <span class="s">&quot;dog&quot;</span>
 <span class="c"># =&gt; Bytes[131, 100, 111, 103]</span></code></pre>
         </div>
 
       <br/>
       <div>
 
-          [<a href="https://github.com/q9f/rlp.cr/blob/5a44229dd0d4942943a70aaecb7e729013a91a97/src/rlp.cr#L151" target="_blank">View source</a>]
-
       </div>
     </div>
 
@@ -479,15 +472,13 @@ <h2>
 
 <ul><li><code>i</code> (<code>Int</code>): the scalar <code>Int</code> number to encode.</li></ul>
 
-<pre><code><span class="t">Rlp</span>.encode <span class="n">1_000_000</span>
+<pre><code class="language-crystal"><span class="t">Rlp</span>.encode <span class="n">1_000_000</span>
 <span class="c"># =&gt; Bytes[131, 15, 66, 64]</span></code></pre>
         </div>
 
       <br/>
       <div>
 
-          [<a href="https://github.com/q9f/rlp.cr/blob/5a44229dd0d4942943a70aaecb7e729013a91a97/src/rlp.cr#L172" target="_blank">View source</a>]
-
       </div>
     </div>
 
@@ -507,15 +498,13 @@ <h2>
 
 <ul><li><code>c</code> (<code>Char</code>): the <code>Char</code> character to encode.</li></ul>
 
-<pre><code><span class="t">Rlp</span>.encode <span class="s">&#39;x&#39;</span>
+<pre><code class="language-crystal"><span class="t">Rlp</span>.encode <span class="s">&#39;x&#39;</span>
 <span class="c"># =&gt; Bytes[120]</span></code></pre>
         </div>
 
       <br/>
       <div>
 
-          [<a href="https://github.com/q9f/rlp.cr/blob/5a44229dd0d4942943a70aaecb7e729013a91a97/src/rlp.cr#L195" target="_blank">View source</a>]
-
       </div>
     </div>
 
@@ -535,15 +524,13 @@ <h2>
 
 <ul><li><code>o</code> (<code>Bool</code>): the boolean <code>Bool</code> value to encode.</li></ul>
 
-<pre><code><span class="t">Rlp</span>.encode <span class="n">true</span>
+<pre><code class="language-crystal"><span class="t">Rlp</span>.encode <span class="n">true</span>
 <span class="c"># =&gt; Bytes[1]</span></code></pre>
         </div>
 
       <br/>
       <div>
 
-          [<a href="https://github.com/q9f/rlp.cr/blob/5a44229dd0d4942943a70aaecb7e729013a91a97/src/rlp.cr#L209" target="_blank">View source</a>]
-
       </div>
     </div>
 

diff --git a/docs/Rlp/RecursiveArray.html b/docs/Rlp/RecursiveArray.html
@@ -3,54 +3,65 @@
 <head>
   <meta charset="utf-8" />
 <meta http-equiv="X-UA-Compatible" content="IE=edge">
-<meta name="generator" content="Crystal Docs 0.32.0">
+<meta name="generator" content="Crystal Docs 1.1.0">
+<meta name="crystal_docs.project_version" content="0.1.7-dev">
+<meta name="crystal_docs.project_name" content="rlp">
+
+
 
 <link href="../css/style.css" rel="stylesheet" type="text/css" />
 <script type="text/javascript" src="../js/doc.js"></script>
 
-<svg class="hidden">
-  <symbol id="octicon-link" viewBox="0 0 16 16">
-    <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
-  </symbol>
-</svg>
-
-  <meta id="repository-name" content="github.com/q9f/rlp.cr">
-  <title>Rlp::RecursiveArray - github.com/q9f/rlp.cr</title>
+  <meta name="repository-name" content="rlp">
+  <title>Rlp::RecursiveArray - rlp 0.1.7-dev</title>
   <script type="text/javascript">
-    CrystalDoc.base_path = "../";
+    CrystalDocs.base_path = "../";
   </script>
 </head>
 <body>
 
+<svg class="hidden">
+  <symbol id="octicon-link" viewBox="0 0 16 16">
+    <path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
+  </symbol>
+</svg>
 <div class="sidebar">
   <div class="sidebar-header">
     <div class="search-box">
       <input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
     </div>
 
-    <div class="repository-links">
-      <a href="../index.html">README</a>
+    <div class="project-summary">
+      <h1 class="project-name">
+        <a href="../index.html">
+          rlp
+        </a>
+      </h1>
+
+      <span class="project-version">
+        0.1.7-dev
+      </span>
     </div>
   </div>
 
-  <div class="search-results" class="hidden">
+  <div class="search-results hidden">
     <ul class="search-list"></ul>
   </div>
 
   <div class="types-list">
     <ul>
 
-  <li class="parent open current" data-id="github.com/q9f/rlp.cr/Rlp" data-name="rlp">
+  <li class="parent open current" data-id="rlp/Rlp" data-name="rlp">
       <a href="../Rlp.html">Rlp</a>
 
         <ul>
 
-  <li class=" current" data-id="github.com/q9f/rlp.cr/Rlp/RecursiveArray" data-name="rlp::recursivearray">
+  <li class=" current" data-id="rlp/Rlp/RecursiveArray" data-name="rlp::recursivearray">
       <a href="../Rlp/RecursiveArray.html">RecursiveArray</a>
 
     </li>
 
-  <li class=" " data-id="github.com/q9f/rlp.cr/Rlp/Util" data-name="rlp::util">
+  <li class=" " data-id="rlp/Rlp/Util" data-name="rlp::util">
       <a href="../Rlp/Util.html">Util</a>
 
     </li>
@@ -94,10 +105,10 @@ <h2>
 a <span class="o">&lt;&lt;</span> <span class="o">[]</span> <span class="k">of</span> <span class="t">RecursiveArray</span></code></pre>
 
 <p><span class="flag orange">TODO</span>  The recursive alias might be deprecated in future,
-ref: <a href="https://github.com/crystal-lang/crystal/issues/5155" target="_blank">crystal-lang/crystal#5155</a>.
+ref: <a href="https://github.com/crystal-lang/crystal/issues/5155">crystal-lang/crystal#5155</a>.
 it's worth considering a custom struct holding a <code>@data</code> property
 of type <code>String | Bytes | Array(RecursiveArray)</code> and forward missing methods,
-ref: <a href="https://github.com/crystal-lang/crystal/issues/8719" target="_blank">crystal-lang/crystal#8719</a>.</p>
+ref: <a href="https://github.com/crystal-lang/crystal/issues/8719">crystal-lang/crystal#8719</a>.</p>
 
 
 
@@ -132,9 +143,7 @@ <h2>
   </h2>
 
 
-      <a href="https://github.com/q9f/rlp.cr/blob/5a44229dd0d4942943a70aaecb7e729013a91a97/src/array.cr#L32" target="_blank">
-        array.cr
-      </a>
+      array.cr
 
     <br/>