Publish autogenerated nightly docs

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/fn.version.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/fn.version.html
index 91b68dbc81bf1985b4e7e11844519a69a4f5f9ab..d6442bd010ba618b6653a247ab8bf5297ceaa1e8 100644 (file)
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/fn.version.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/fn.version.html
@@ -6,6 +6,6 @@
                     <img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt="logo"></div>
         </a><div class="sidebar-elems"><h2 class="location">In <a href="index.html">bdk</a></h2><div id="sidebar-vars" data-name="version" data-ty="fn" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../bdk/index.html">
                         <img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
-    <h1 class="fqn"><span class="in-band">Function <a href="index.html">bdk</a>::<wbr><a class="fn" href="#">version</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/bdk/lib.rs.html#279-281" title="goto source code">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn version() -&gt; &amp;'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Get the version of BDK at runtime</p>
+    <h1 class="fqn"><span class="in-band">Function <a href="index.html">bdk</a>::<wbr><a class="fn" href="#">version</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/bdk/lib.rs.html#277-279" title="goto source code">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn version() -&gt; &amp;'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Get the version of BDK at runtime</p>
 </div></details></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="bdk" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.60.0-nightly (51126be1b 2022-01-24)" ></div>
 </body></html>
\ No newline at end of file

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/index.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/index.html
index fe59bec85b700b3972f4f32e96c4dec9cea5e91d..816922df6c646a06d2568f3652230360c47f69f6 100644 (file)
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/index.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/index.html
@@ -6,7 +6,7 @@
                     <img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt="logo"></div>
         </a><h2 class="location"><a href="#">Crate bdk</a></h2><div class="sidebar-elems"><div class="block"><ul><li class="version">Version 0.17.1-dev</li><li><a id="all-types" href="all.html">All Items</a></li></div></ul><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><div id="sidebar-vars" data-name="bdk" data-ty="mod" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../bdk/index.html">
                         <img src="https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
-    <h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">bdk</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/bdk/lib.rs.html#13-288" title="goto source code">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A modern, lightweight, descriptor-based wallet library written in Rust.</p>
+    <h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">bdk</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/bdk/lib.rs.html#13-286" title="goto source code">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A modern, lightweight, descriptor-based wallet library written in Rust.</p>
 <h2 id="about" class="section-header"><a href="#about">About</a></h2>
 <p>The BDK library aims to be the core building block for Bitcoin wallets of any kind.</p>
 <ul>
@@ -25,7 +25,7 @@ their uses.</p>
 The default features include a simple key-value database (<a href="sled"><code>sled</code></a>) to cache
 blockchain data and an <a href="https://docs.rs/electrum-client/">electrum</a> blockchain client to
 interact with the bitcoin P2P network.</p>
-<div class="example-wrap"><pre class="language-toml"><code>bdk = &quot;0.17.0&quot;</code></pre></div><h3 id="sync-the-balance-of-a-descriptor" class="section-header"><a href="#sync-the-balance-of-a-descriptor">Sync the balance of a descriptor</a></h3><h4 id="example" class="section-header"><a href="#example">Example</a></h4>
+<div class="example-wrap"><pre class="language-toml"><code>bdk = &quot;0.17.0&quot;</code></pre></div><h2 id="examples" class="section-header"><a href="#examples">Examples</a></h2><h3 id="sync-the-balance-of-a-descriptor" class="section-header"><a href="#sync-the-balance-of-a-descriptor">Sync the balance of a descriptor</a></h3>
 <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">bdk</span>::{<span class="ident">Wallet</span>, <span class="ident">SyncOptions</span>};
 <span class="kw">use</span> <span class="ident">bdk::database::MemoryDatabase</span>;
 <span class="kw">use</span> <span class="ident">bdk::blockchain::ElectrumBlockchain</span>;
@@ -47,7 +47,7 @@ interact with the bitcoin P2P network.</p>
 
     <span class="prelude-val">Ok</span>(())
 }</code></pre></div>
-<h3 id="generate-a-few-addresses" class="section-header"><a href="#generate-a-few-addresses">Generate a few addresses</a></h3><h4 id="example-1" class="section-header"><a href="#example-1">Example</a></h4>
+<h3 id="generate-a-few-addresses" class="section-header"><a href="#generate-a-few-addresses">Generate a few addresses</a></h3>
 <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">bdk</span>::{<span class="ident">Wallet</span>};
 <span class="kw">use</span> <span class="ident">bdk::database::MemoryDatabase</span>;
 <span class="kw">use</span> <span class="ident">bdk::wallet::AddressIndex::New</span>;
@@ -66,7 +66,7 @@ interact with the bitcoin P2P network.</p>
 
     <span class="prelude-val">Ok</span>(())
 }</code></pre></div>
-<h3 id="create-a-transaction" class="section-header"><a href="#create-a-transaction">Create a transaction</a></h3><h4 id="example-2" class="section-header"><a href="#example-2">Example</a></h4>
+<h3 id="create-a-transaction" class="section-header"><a href="#create-a-transaction">Create a transaction</a></h3>
 <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">bdk</span>::{<span class="ident">FeeRate</span>, <span class="ident">Wallet</span>, <span class="ident">SyncOptions</span>};
 <span class="kw">use</span> <span class="ident">bdk::database::MemoryDatabase</span>;
 <span class="kw">use</span> <span class="ident">bdk::blockchain::ElectrumBlockchain</span>;
@@ -103,7 +103,7 @@ interact with the bitcoin P2P network.</p>
 
     <span class="prelude-val">Ok</span>(())
 }</code></pre></div>
-<h3 id="sign-a-transaction" class="section-header"><a href="#sign-a-transaction">Sign a transaction</a></h3><h4 id="example-3" class="section-header"><a href="#example-3">Example</a></h4>
+<h3 id="sign-a-transaction" class="section-header"><a href="#sign-a-transaction">Sign a transaction</a></h3>
 <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">std::str::FromStr</span>;
 
 <span class="kw">use</span> <span class="ident">bitcoin::util::psbt::PartiallySignedTransaction</span> <span class="kw">as</span> <span class="ident">Psbt</span>;
@@ -139,7 +139,7 @@ Below is a list of the available feature flags and the additional functionality
 <li><code>async-interface</code>: async functions in bdk traits</li>
 <li><code>keys-bip39</code>: <a href="https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki">BIP-39</a> mnemonic codes for generating deterministic keys</li>
 </ul>
-<h3 id="internal-features" class="section-header"><a href="#internal-features">Internal features</a></h3>
+<h2 id="internal-features" class="section-header"><a href="#internal-features">Internal features</a></h2>
 <p>These features do not expose any new API, but influence internal implementation aspects of
 BDK.</p>
 <ul>

diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk/lib.rs.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk/lib.rs.html
index 31c42bc371dc33191cbf3855b409ed80dd8cebd4..1e0206b27f4239a7e9cec6a7d09e6d531e275e9d 100644 (file)
--- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk/lib.rs.html
+++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk/lib.rs.html
@@ -291,8 +291,6 @@
 <span id="284">284</span>
 <span id="285">285</span>
 <span id="286">286</span>
-<span id="287">287</span>
-<span id="288">288</span>
 </pre><pre class="rust"><code><span class="comment">// Bitcoin Dev Kit</span>
 <span class="comment">// Written in 2020 by Alekos Filini &lt;alekos.filini@gmail.com&gt;</span>
 <span class="comment">//</span>
@@ -341,12 +339,13 @@
 <span class="doccomment">//! ```toml</span>
 <span class="doccomment">//! bdk = &quot;0.17.0&quot;</span>
 <span class="doccomment">//! ```</span>
+<span class="doccomment">//!</span>
+<span class="doccomment">//! # Examples</span>
 <span class="attribute">#![<span class="ident">cfg_attr</span>(
     <span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;electrum&quot;</span>,
     <span class="ident">doc</span> <span class="op">=</span> <span class="string">r##&quot;
 ## Sync the balance of a descriptor
 
-### Example
 ```no_run
 use bdk::{Wallet, SyncOptions};
 use bdk::database::MemoryDatabase;
@@ -375,7 +374,6 @@ fn main() -&gt; Result&lt;(), bdk::Error&gt; {
 <span class="doccomment">//!</span>
 <span class="doccomment">//! ## Generate a few addresses</span>
 <span class="doccomment">//!</span>
-<span class="doccomment">//! ### Example</span>
 <span class="doccomment">//! ```</span>
 <span class="doccomment">//! use bdk::{Wallet};</span>
 <span class="doccomment">//! use bdk::database::MemoryDatabase;</span>
@@ -401,7 +399,6 @@ fn main() -&gt; Result&lt;(), bdk::Error&gt; {
     <span class="ident">doc</span> <span class="op">=</span> <span class="string">r##&quot;
 ## Create a transaction
 
-### Example
 ```no_run
 use bdk::{FeeRate, Wallet, SyncOptions};
 use bdk::database::MemoryDatabase;
@@ -445,7 +442,6 @@ fn main() -&gt; Result&lt;(), bdk::Error&gt; {
 <span class="doccomment">//!</span>
 <span class="doccomment">//! ## Sign a transaction</span>
 <span class="doccomment">//!</span>
-<span class="doccomment">//! ### Example</span>
 <span class="doccomment">//! ```no_run</span>
 <span class="doccomment">//! use std::str::FromStr;</span>
 <span class="doccomment">//!</span>
@@ -487,7 +483,7 @@ fn main() -&gt; Result&lt;(), bdk::Error&gt; {
 <span class="doccomment">//! * `async-interface`: async functions in bdk traits</span>
 <span class="doccomment">//! * `keys-bip39`: [BIP-39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) mnemonic codes for generating deterministic keys</span>
 <span class="doccomment">//!</span>
-<span class="doccomment">//! ## Internal features</span>
+<span class="doccomment">//! # Internal features</span>
 <span class="doccomment">//!</span>
 <span class="doccomment">//! These features do not expose any new API, but influence internal implementation aspects of</span>
 <span class="doccomment">//! BDK.</span>