Skip to content

Commit

Permalink
fix path issue
Browse files Browse the repository at this point in the history
  • Loading branch information
bitkarrot committed Dec 10, 2024
1 parent fa839e2 commit 52c6f21
Show file tree
Hide file tree
Showing 13 changed files with 1,408 additions and 339 deletions.
Binary file modified bdk-python/docs/_build/html/.doctrees/api.doctree
Binary file not shown.
Binary file modified bdk-python/docs/_build/html/.doctrees/environment.pickle
Binary file not shown.
136 changes: 26 additions & 110 deletions bdk-python/docs/_build/html/_modules/bdkpython/bdk.html

Large diffs are not rendered by default.

5 changes: 1 addition & 4 deletions bdk-python/docs/_build/html/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,7 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api.html">BDK Python API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api.html#api-reference">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api.html#bdk-module">Bdk Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api.html#bitcoin-module">Bitcoin Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api.html">API Reference</a></li>
</ul>

</div>
Expand Down
128 changes: 97 additions & 31 deletions bdk-python/docs/_build/html/_sources/api.rst.txt
Original file line number Diff line number Diff line change
@@ -1,31 +1,97 @@
BDK Python API Reference
=====================

This document describes the Python API for the Bitcoin Development Kit (BDK).

Bdk Module
==========
Bitcoin Module
==============

Examples
--------

Basic Wallet Usage
~~~~~~~~~~~~~~~~

.. code-block:: python
from bdkpython import *
# Create a new wallet
descriptor = "wpkh(...)" # Your descriptor here
wallet = Wallet(descriptor, network=Network.TESTNET)
# Sync wallet
blockchain = Blockchain("https://blockstream.info/testnet/api")
wallet.sync(blockchain)
# Get balance
balance = wallet.get_balance()
print(f"Confirmed balance: {balance.confirmed}")
API Reference
============

.. currentmodule:: bdkpython

Core Types
----------

.. autoclass:: Amount
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: FeeRate
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: Address
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: Script
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: OutPoint
:members:
:undoc-members:
:show-inheritance:

Wallet Operations
-----------------

.. autoclass:: TxBuilder
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: BumpFeeTxBuilder
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: Psbt
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: ElectrumClient
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: EsploraClient
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: Wallet
:members:
:undoc-members:
:show-inheritance:

Utilities
---------

.. autoclass:: Mnemonic
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: Network
:members:
:undoc-members:
:show-inheritance:

Exceptions
----------

.. autoclass:: InternalError
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: FeeRateError
:members:
:undoc-members:
:show-inheritance:

.. autoclass:: ParseAmountError
:members:
:undoc-members:
:show-inheritance:

797 changes: 765 additions & 32 deletions bdk-python/docs/_build/html/api.html

Large diffs are not rendered by default.

Loading

0 comments on commit 52c6f21

Please sign in to comment.