Skip to content

Commit

Permalink
add manually format api.rst for sections
Browse files Browse the repository at this point in the history
  • Loading branch information
bitkarrot committed Dec 10, 2024
1 parent 4ab2579 commit 7556d01
Show file tree
Hide file tree
Showing 12 changed files with 15,896 additions and 3 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.
14,308 changes: 14,308 additions & 0 deletions bdk-python/docs/_build/html/_modules/bdkpython/bdk.html

Large diffs are not rendered by default.

104 changes: 104 additions & 0 deletions bdk-python/docs/_build/html/_modules/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@


<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &mdash; BDK Python 0.1.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />


<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=01f34227"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="../index.html" class="icon icon-home">
BDK Python
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</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>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">BDK Python</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Overview: module code</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<h1>All modules for which code is available</h1>
<ul><li><a href="bdkpython/bdk.html">bdkpython.bdk</a></li>
</ul>

</div>
</div>
<footer>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2024, Bitcoin Dev Kit.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
93 changes: 92 additions & 1 deletion bdk-python/docs/_build/html/_sources/api.rst.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,99 @@
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 Down
Loading

0 comments on commit 7556d01

Please sign in to comment.