Skip to content

Commit

Permalink
latest docs generated
Browse files Browse the repository at this point in the history
  • Loading branch information
bitkarrot committed Dec 10, 2024
1 parent 7556d01 commit 56f2a46
Show file tree
Hide file tree
Showing 10 changed files with 5 additions and 1,486 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.
95 changes: 2 additions & 93 deletions bdk-python/docs/_build/html/_sources/api.rst.txt
Original file line number Diff line number Diff line change
@@ -1,99 +1,8 @@
BDK Python API Reference
==========================
=====================

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

API Reference
==============

.. currentmodule:: bdkpython

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

Addresses and Scripts
~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: Address
:members:
:undoc-members:
:show-inheritance:


Descriptors
~~~~~~~~~~~~
.. autoclass:: Descriptor
:members:
:undoc-members:
:show-inheritance:

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

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

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

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

Transaction Building
~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: TxBuilder
:members:
:undoc-members:
:show-inheritance:

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

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

Blockchain Clients
~~~~~~~~~~~~~~~~~~~
.. autoclass:: ElectrumClient
:members:
:undoc-members:
:show-inheritance:

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

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

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

Exceptions
-----------
.. autoexception:: InternalError
:members:
:show-inheritance:


Bdk Module
==========
Bitcoin Module
Expand All @@ -103,7 +12,7 @@ Examples
--------

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

.. code-block:: python
Expand Down
861 changes: 0 additions & 861 deletions bdk-python/docs/_build/html/api.html

Large diffs are not rendered by default.

Loading

0 comments on commit 56f2a46

Please sign in to comment.