docs: regenerate crystal documentation (#46)

q9f · Sep 29, 2021 · 7f5bb4f · 7f5bb4f
1 parent d994c7c
commit 7f5bb4f
Show file tree

Hide file tree

Showing 18 changed files with 867 additions and 834 deletions.
diff --git a/docs/Secp256k1.html b/docs/Secp256k1.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.31.1">
+<meta name="generator" content="Crystal Docs 1.1.0">
+<meta name="crystal_docs.project_version" content="0.3.5-dev">
+<meta name="crystal_docs.project_name" content="secp256k1">
+
+
 
 <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/secp256k1.cr">
-  <title>Secp256k1 - github.com/q9f/secp256k1.cr</title>
+  <meta name="repository-name" content="secp256k1">
+  <title>Secp256k1 - secp256k1 0.3.5-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">
+          secp256k1
+        </a>
+      </h1>
+
+      <span class="project-version">
+        0.3.5-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/secp256k1.cr/Secp256k1" data-name="secp256k1">
+  <li class="parent open current" data-id="secp256k1/Secp256k1" data-name="secp256k1">
       <a href="Secp256k1.html">Secp256k1</a>
 
         <ul>
 
-  <li class="parent " data-id="github.com/q9f/secp256k1.cr/Secp256k1/Bitcoin" data-name="secp256k1::bitcoin">
+  <li class="parent " data-id="secp256k1/Secp256k1/Bitcoin" data-name="secp256k1::bitcoin">
       <a href="Secp256k1/Bitcoin.html">Bitcoin</a>
 
         <ul>
 
-  <li class=" " data-id="github.com/q9f/secp256k1.cr/Secp256k1/Bitcoin/Account" data-name="secp256k1::bitcoin::account">
+  <li class=" " data-id="secp256k1/Secp256k1/Bitcoin/Account" data-name="secp256k1::bitcoin::account">
       <a href="Secp256k1/Bitcoin/Account.html">Account</a>
 
     </li>
@@ -60,32 +71,32 @@
 
     </li>
 
-  <li class=" " data-id="github.com/q9f/secp256k1.cr/Secp256k1/Core" data-name="secp256k1::core">
+  <li class=" " data-id="secp256k1/Secp256k1/Core" data-name="secp256k1::core">
       <a href="Secp256k1/Core.html">Core</a>
 
     </li>
 
-  <li class=" " data-id="github.com/q9f/secp256k1.cr/Secp256k1/ECDSASignature" data-name="secp256k1::ecdsasignature">
+  <li class=" " data-id="secp256k1/Secp256k1/ECDSASignature" data-name="secp256k1::ecdsasignature">
       <a href="Secp256k1/ECDSASignature.html">ECDSASignature</a>
 
     </li>
 
-  <li class=" " data-id="github.com/q9f/secp256k1.cr/Secp256k1/ECPoint" data-name="secp256k1::ecpoint">
+  <li class=" " data-id="secp256k1/Secp256k1/ECPoint" data-name="secp256k1::ecpoint">
       <a href="Secp256k1/ECPoint.html">ECPoint</a>
 
     </li>
 
-  <li class="parent " data-id="github.com/q9f/secp256k1.cr/Secp256k1/Ethereum" data-name="secp256k1::ethereum">
+  <li class="parent " data-id="secp256k1/Secp256k1/Ethereum" data-name="secp256k1::ethereum">
       <a href="Secp256k1/Ethereum.html">Ethereum</a>
 
         <ul>
 
-  <li class=" " data-id="github.com/q9f/secp256k1.cr/Secp256k1/Ethereum/Account" data-name="secp256k1::ethereum::account">
+  <li class=" " data-id="secp256k1/Secp256k1/Ethereum/Account" data-name="secp256k1::ethereum::account">
       <a href="Secp256k1/Ethereum/Account.html">Account</a>
 
     </li>
 
-  <li class=" " data-id="github.com/q9f/secp256k1.cr/Secp256k1/Ethereum/Enode" data-name="secp256k1::ethereum::enode">
+  <li class=" " data-id="secp256k1/Secp256k1/Ethereum/Enode" data-name="secp256k1::ethereum::enode">
       <a href="Secp256k1/Ethereum/Enode.html">Enode</a>
 
     </li>
@@ -95,22 +106,22 @@
 
     </li>
 
-  <li class=" " data-id="github.com/q9f/secp256k1.cr/Secp256k1/Hash" data-name="secp256k1::hash">
+  <li class=" " data-id="secp256k1/Secp256k1/Hash" data-name="secp256k1::hash">
       <a href="Secp256k1/Hash.html">Hash</a>
 
     </li>
 
-  <li class=" " data-id="github.com/q9f/secp256k1.cr/Secp256k1/Keypair" data-name="secp256k1::keypair">
+  <li class=" " data-id="secp256k1/Secp256k1/Keypair" data-name="secp256k1::keypair">
       <a href="Secp256k1/Keypair.html">Keypair</a>
 
     </li>
 
-  <li class=" " data-id="github.com/q9f/secp256k1.cr/Secp256k1/Signature" data-name="secp256k1::signature">
+  <li class=" " data-id="secp256k1/Secp256k1/Signature" data-name="secp256k1::signature">
       <a href="Secp256k1/Signature.html">Signature</a>
 
     </li>
 
-  <li class=" " data-id="github.com/q9f/secp256k1.cr/Secp256k1/Util" data-name="secp256k1::util">
+  <li class=" " data-id="secp256k1/Secp256k1/Util" data-name="secp256k1::util">
       <a href="Secp256k1/Util.html">Util</a>
 
     </li>
@@ -147,10 +158,10 @@ <h2>
   </h2>
 
   <p>Implements 256-bit <code><a href="Secp256k1.html">Secp256k1</a></code> Koblitz elliptic curve.
-Ref: <a href="https://www.secg.org/sec2-v2.pdf" target="_blank">secg.org/sec2-v2.pdf</a></p>
+Ref: <a href="https://www.secg.org/sec2-v2.pdf">secg.org/sec2-v2.pdf</a></p>
 
 <p><code><a href="Secp256k1.html">Secp256k1</a></code> has the characteristic prime <code>p</code>, it is defined over the prime field ℤ_p.
-Ref: <a href="https://en.bitcoin.it/wiki/Secp256k1" target="_blank">en.bitcoin.it/wiki/Secp256k1</a></p>
+Ref: <a href="https://en.bitcoin.it/wiki/Secp256k1">en.bitcoin.it/wiki/Secp256k1</a></p>
 
 
 
@@ -175,37 +186,27 @@ <h2>
   </h2>
 
 
-      <a href="https://github.com/q9f/secp256k1.cr/blob/f6ea8e70d50b6270fa3f31c07fb97831baff6d5b/src/bitcoin.cr#L16" target="_blank">
-        bitcoin.cr
-      </a>
+      bitcoin.cr
 
     <br/>
 
 
-      <a href="https://github.com/q9f/secp256k1.cr/blob/f6ea8e70d50b6270fa3f31c07fb97831baff6d5b/src/constants.cr#L22" target="_blank">
-        constants.cr
-      </a>
+      constants.cr
 
     <br/>
 
 
-      <a href="https://github.com/q9f/secp256k1.cr/blob/f6ea8e70d50b6270fa3f31c07fb97831baff6d5b/src/structs.cr#L20" target="_blank">
-        structs.cr
-      </a>
+      secp256k1.cr
 
     <br/>
 
 
-      <a href="https://github.com/q9f/secp256k1.cr/blob/f6ea8e70d50b6270fa3f31c07fb97831baff6d5b/src/version.cr#L20" target="_blank">
-        version.cr
-      </a>
+      structs.cr
 
     <br/>
 
 
-      <a href="https://github.com/q9f/secp256k1.cr/blob/f6ea8e70d50b6270fa3f31c07fb97831baff6d5b/src/secp256k1.cr#L30" target="_blank">
-        secp256k1.cr
-      </a>
+      version.cr
 
     <br/>
 
@@ -321,7 +322,7 @@ <h2>
 
 
       <dt class="entry-const" id="VERSION">
-        <strong>VERSION</strong> = <code><span class="s">&quot;0.3.0&quot;</span></code>
+        <strong>VERSION</strong> = <code><span class="s">&quot;0.3.6&quot;</span></code>
       </dt>
 
       <dd class="entry-const-doc">