Skip to content

Commit c9dde87

Browse files
everoddandeveneveroddandeven
committed
Documentation improvements
* Improve docstrings * Fix typos * Add documentation pages * Update README
1 parent 1eb313a commit c9dde87

271 files changed

Lines changed: 11814 additions & 1630 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,5 @@ test_wallets
1212
.idea
1313
.codacy
1414
coverage*
15-
.coverage
15+
.coverage
16+
.cache

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ A Python library for creating Monero applications using RPC and Python bindings
2020
* Supports wallet and daemon RPC clients.
2121
* Supports client-side wallets using Python bindings.
2222
* Supports multisig, view-only, and offline wallets.
23-
* Wallet types are interchangeable by conforming to a [common interface](https://woodser.github.io/monero-java/javadocs/monero/wallet/MoneroWallet.html).
23+
* Wallet types are interchangeable by conforming to a [common interface](https://everoddandeven.github.io/monero-python/mkdocs/public/api/wallet/).
2424
* Uses a clearly defined [data model and API specification](https://github.com/everoddandeven/monero-python/blob/main/docs/monero-spec.pdf) intended to be intuitive and robust.
2525
* Query wallet transactions, transfers, and outputs by their properties.
2626
* Fetch and process binary data from the daemon (e.g. raw blocks).
@@ -31,7 +31,7 @@ A Python library for creating Monero applications using RPC and Python bindings
3131
<p align="center">
3232
<img width="85%" height="auto" src="docs/architecture.png"/><br>
3333
<i>Build Python
34-
applications using RPC or Python bindings to <a href="https://github.com/monero-project/monero">monero-project/monero</a>. Wallet implementations are interchangeable by conforming to a common interface, <a href="https://woodser.github.io/monero-java/javadocs/monero/wallet/MoneroWallet.html">MoneroWallet</a>.</i>
34+
applications using RPC or Python bindings to <a href="https://github.com/monero-project/monero">monero-project/monero</a>. Wallet implementations are interchangeable by conforming to a common interface, <a href="https://everoddandeven.github.io/monero-python/mkdocs/public/api/wallet/">MoneroWallet</a>.</i>
3535
</p>
3636

3737

‎conftest.py‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,17 @@
22

33

44
def pytest_runtest_call(item: pytest.Item):
5-
# get not_supported marked
6-
marker = item.get_closest_marker("not_supported")
7-
not_implemented = False
5+
# get not_supported marker
6+
marker: pytest.Mark | None = item.get_closest_marker("not_supported")
7+
not_implemented: bool = False
8+
89
if marker is None:
10+
# get not_implemented marker
911
marker = item.get_closest_marker("not_implemented")
1012
not_implemented = True
1113

1214
if marker is None:
13-
# marked not found
15+
# marker not found
1416
return
1517

1618
try:

‎docs/mkdocs/404.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{% extends "main.html" %}
2+
{% block content %}
3+
<h1>401 - Unauthorized</h1>
4+
{% endblock %}

‎docs/mkdocs/docs/en/api/architecture.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: Architecture
3+
---
4+
# Architecture
5+
6+
<p align="center">
7+
<img width="100%" height="auto" src="../../images/architecture.png"/><br>
8+
</p>

‎docs/mkdocs/docs/en/api/connection.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: RPC Connection
3+
---
4+
# RPC Connection
5+
6+
::: monero.MoneroRpcConnection

‎docs/mkdocs/docs/en/api/daemon.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Daemon Interface
3+
---
4+
# Daemon Interface
5+
6+
::: monero.MoneroDaemon

‎docs/mkdocs/docs/en/api/daemon_rpc.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Daemon RPC
3+
---
4+
# Daemon RPC
5+
6+
::: monero.MoneroDaemonRpc

‎docs/mkdocs/docs/en/api/data_model/connection.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Connection Data Model
3+
---
4+
# Connection Data Model
5+
6+
::: monero.MoneroSslOptions
7+
8+
::: monero.MoneroConnectionType
9+
10+
::: monero.MoneroConnectionPriorityComparator

‎docs/mkdocs/docs/en/api/data_model/daemon.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: Daemon Data Model
3+
---
4+
# Daemon Data Model
5+
6+
::: monero.MoneroNetworkType
7+
8+
::: monero.MoneroVersion
9+
10+
::: monero.MoneroBlockHeader
11+
12+
::: monero.MoneroBlock
13+
14+
::: monero.MoneroTx
15+
16+
::: monero.MoneroKeyImage
17+
18+
::: monero.MoneroOutput
19+
20+
::: monero.MoneroAltChain
21+
22+
::: monero.MoneroBan
23+
24+
::: monero.MoneroPruneResult
25+
26+
::: monero.MoneroMiningStatus
27+
28+
::: monero.MoneroMinerTxSum
29+
30+
::: monero.MoneroBlockTemplate
31+
32+
::: monero.MoneroConnectionSpan
33+
34+
::: monero.MoneroPeer
35+
36+
::: monero.MoneroSubmitTxResult
37+
38+
::: monero.MoneroTxBacklogEntry
39+
40+
::: monero.MoneroOutputDistributionEntry
41+
42+
::: monero.MoneroOutputHistogramEntry
43+
44+
::: monero.MoneroTxPoolStats
45+
46+
::: monero.MoneroDaemonUpdateCheckResult
47+
48+
::: monero.MoneroDaemonUpdateDownloadResult
49+
50+
::: monero.MoneroFeeEstimate
51+
52+
::: monero.MoneroDaemonInfo
53+
54+
::: monero.MoneroDaemonSyncInfo
55+
56+
::: monero.MoneroHardForkInfo
57+
58+
::: monero.MoneroDaemonListener

0 commit comments

Comments
 (0)