CAT_TOM/pyasic
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update documentation.

Browse Source
This commit is contained in:
UpstreamData
2023-03-14 09:07:26 -06:00
parent 05cfe8cc5d
commit 92e972aa57
29 changed files with 399 additions and 226 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/miners/antminer/X15.md Normal file
View File

@@ -0,0 +1,11 @@
# pyasic
## X15 Models
## Z15
::: pyasic.miners.zec.antminer.cgminer.X15.Z15.CGMinerZ15
handler: python
options:
show_root_heading: false
heading_level: 4

28
docs/miners/antminer/X17.md
View File

@@ -3,7 +3,7 @@
## S17 ## S17
::: pyasic.miners.antminer.bmminer.X17.S17.BMMinerS17 ::: pyasic.miners.btc.antminer.bmminer.X17.S17.BMMinerS17
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -11,7 +11,7 @@
## S17+ ## S17+
::: pyasic.miners.antminer.bmminer.X17.S17_Plus.BMMinerS17Plus ::: pyasic.miners.btc.antminer.bmminer.X17.S17_Plus.BMMinerS17Plus
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -19,7 +19,7 @@
## S17 Pro ## S17 Pro
::: pyasic.miners.antminer.bmminer.X17.S17_Pro.BMMinerS17Pro ::: pyasic.miners.btc.antminer.bmminer.X17.S17_Pro.BMMinerS17Pro
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -27,7 +27,7 @@
## S17e ## S17e
::: pyasic.miners.antminer.bmminer.X17.S17e.BMMinerS17e ::: pyasic.miners.btc.antminer.bmminer.X17.S17e.BMMinerS17e
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -35,7 +35,7 @@
## T17 ## T17
::: pyasic.miners.antminer.bmminer.X17.T17.BMMinerT17 ::: pyasic.miners.btc.antminer.bmminer.X17.T17.BMMinerT17
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -43,7 +43,7 @@
## T17+ ## T17+
::: pyasic.miners.antminer.bmminer.X17.T17_Plus.BMMinerT17Plus ::: pyasic.miners.btc.antminer.bmminer.X17.T17_Plus.BMMinerT17Plus
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -52,7 +52,7 @@
## T17e ## T17e
::: pyasic.miners.antminer.bmminer.X17.T17e.BMMinerT17e ::: pyasic.miners.btc.antminer.bmminer.X17.T17e.BMMinerT17e
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -61,7 +61,7 @@
## S17 (BOS) ## S17 (BOS)
::: pyasic.miners.antminer.bosminer.X17.S17.BOSMinerS17 ::: pyasic.miners.btc.antminer.bosminer.X17.S17.BOSMinerS17
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -69,7 +69,7 @@
## S17+ (BOS) ## S17+ (BOS)
::: pyasic.miners.antminer.bosminer.X17.S17_Plus.BOSMinerS17Plus ::: pyasic.miners.btc.antminer.bosminer.X17.S17_Plus.BOSMinerS17Plus
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -77,7 +77,7 @@
## S17 Pro (BOS) ## S17 Pro (BOS)
::: pyasic.miners.antminer.bosminer.X17.S17_Pro.BOSMinerS17Pro ::: pyasic.miners.btc.antminer.bosminer.X17.S17_Pro.BOSMinerS17Pro
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -85,7 +85,7 @@
## S17e (BOS) ## S17e (BOS)
::: pyasic.miners.antminer.bosminer.X17.S17e.BOSMinerS17e ::: pyasic.miners.btc.antminer.bosminer.X17.S17e.BOSMinerS17e
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -93,7 +93,7 @@
## T17 (BOS) ## T17 (BOS)
::: pyasic.miners.antminer.bosminer.X17.T17.BOSMinerT17 ::: pyasic.miners.btc.antminer.bosminer.X17.T17.BOSMinerT17
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -101,7 +101,7 @@
## T17+ (BOS) ## T17+ (BOS)
::: pyasic.miners.antminer.bosminer.X17.T17_Plus.BOSMinerT17Plus ::: pyasic.miners.btc.antminer.bosminer.X17.T17_Plus.BOSMinerT17Plus
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -110,7 +110,7 @@
## T17e (BOS) ## T17e (BOS)
::: pyasic.miners.antminer.bosminer.X17.T17e.BOSMinerT17e ::: pyasic.miners.btc.antminer.bosminer.X17.T17e.BOSMinerT17e
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false

24
docs/miners/antminer/X19.md
View File

@@ -3,7 +3,7 @@
## S19 ## S19
::: pyasic.miners.antminer.bmminer.X19.S19.BMMinerS19 ::: pyasic.miners.btc.antminer.bmminer.X19.S19.BMMinerS19
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -11,7 +11,7 @@
## S19 Pro ## S19 Pro
::: pyasic.miners.antminer.bmminer.X19.S19_Pro.BMMinerS19Pro ::: pyasic.miners.btc.antminer.bmminer.X19.S19_Pro.BMMinerS19Pro
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -20,7 +20,7 @@
## S19a ## S19a
::: pyasic.miners.antminer.bmminer.X19.S19a.BMMinerS19a ::: pyasic.miners.btc.antminer.bmminer.X19.S19a.BMMinerS19a
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -29,7 +29,7 @@
## S19j ## S19j
::: pyasic.miners.antminer.bmminer.X19.S19j.BMMinerS19j ::: pyasic.miners.btc.antminer.bmminer.X19.S19j.BMMinerS19j
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -37,7 +37,7 @@
## S19j Pro ## S19j Pro
::: pyasic.miners.antminer.bmminer.X19.S19j_Pro.BMMinerS19jPro ::: pyasic.miners.btc.antminer.bmminer.X19.S19j_Pro.BMMinerS19jPro
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -45,7 +45,7 @@
## S19 XP ## S19 XP
::: pyasic.miners.antminer.bmminer.X19.S19_XP.BMMinerS19XP ::: pyasic.miners.btc.antminer.bmminer.X19.S19_XP.BMMinerS19XP
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -53,7 +53,7 @@
## T19 ## T19
::: pyasic.miners.antminer.bmminer.X19.T19.BMMinerT19 ::: pyasic.miners.btc.antminer.bmminer.X19.T19.BMMinerT19
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -62,7 +62,7 @@
## S19 (BOS) ## S19 (BOS)
::: pyasic.miners.antminer.bosminer.X19.S19.BOSMinerS19 ::: pyasic.miners.btc.antminer.bosminer.X19.S19.BOSMinerS19
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -70,7 +70,7 @@
## S19 Pro (BOS) ## S19 Pro (BOS)
::: pyasic.miners.antminer.bosminer.X19.S19_Pro.BOSMinerS19Pro ::: pyasic.miners.btc.antminer.bosminer.X19.S19_Pro.BOSMinerS19Pro
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -79,7 +79,7 @@
## S19j (BOS) ## S19j (BOS)
::: pyasic.miners.antminer.bosminer.X19.S19j.BOSMinerS19j ::: pyasic.miners.btc.antminer.bosminer.X19.S19j.BOSMinerS19j
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -87,7 +87,7 @@
## S19j Pro (BOS) ## S19j Pro (BOS)
::: pyasic.miners.antminer.bosminer.X19.S19j_Pro.BOSMinerS19jPro ::: pyasic.miners.btc.antminer.bosminer.X19.S19j_Pro.BOSMinerS19jPro
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -95,7 +95,7 @@
## T19 (BOS) ## T19 (BOS)
::: pyasic.miners.antminer.bosminer.X19.T19.BOSMinerT19 ::: pyasic.miners.btc.antminer.bosminer.X19.T19.BOSMinerT19
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false

11
docs/miners/antminer/X3.md Normal file
View File

@@ -0,0 +1,11 @@
# pyasic
## X3 Models
## HS3
::: pyasic.miners.hns.antminer.cgminer.X3.HS3.CGMinerHS3
handler: python
options:
show_root_heading: false
heading_level: 4

11
docs/miners/antminer/X5.md Normal file
View File

@@ -0,0 +1,11 @@
# pyasic
## X5 Models
## DR5
::: pyasic.miners.dcr.antminer.cgminer.X5.DR5.CGMinerDR5
handler: python
options:
show_root_heading: false
heading_level: 4

11
docs/miners/antminer/X7.md Normal file
View File

@@ -0,0 +1,11 @@
# pyasic
## X7 Models
## L7
::: pyasic.miners.ltc.antminer.bmminer.X7.L7.BMMinerL7
handler: python
options:
show_root_heading: false
heading_level: 4

16
docs/miners/antminer/X9.md
View File

@@ -4,7 +4,7 @@
## X9 (BOS) ## X9 (BOS)
::: pyasic.miners.antminer.bosminer.X9.S9.BOSMinerS9 ::: pyasic.miners.btc.antminer.bosminer.X9.S9.BOSMinerS9
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -13,7 +13,7 @@
## S9 ## S9
::: pyasic.miners.antminer.bmminer.X9.S9.BMMinerS9 ::: pyasic.miners.btc.antminer.bmminer.X9.S9.BMMinerS9
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -21,7 +21,7 @@
## S9i ## S9i
::: pyasic.miners.antminer.bmminer.X9.S9i.BMMinerS9i ::: pyasic.miners.btc.antminer.bmminer.X9.S9i.BMMinerS9i
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -29,7 +29,15 @@
## T9 ## T9
::: pyasic.miners.antminer.bmminer.X9.T9.BMMinerT9 ::: pyasic.miners.btc.antminer.bmminer.X9.T9.BMMinerT9
handler: python
options:
show_root_heading: false
heading_level: 4
## E9 Pro
::: pyasic.miners.etc.antminer.cgminer.X9.E9_Pro.CGMinerE9Pro
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false

6
docs/miners/avalonminer/A10X.md
View File

@@ -3,7 +3,7 @@
## A1026 ## A1026
::: pyasic.miners.avalonminer.cgminer.A10X.A1026.CGMinerAvalon1026 ::: pyasic.miners.btc.avalonminer.cgminer.A10X.A1026.CGMinerAvalon1026
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -11,7 +11,7 @@
## A1047 ## A1047
::: pyasic.miners.avalonminer.cgminer.A10X.A1047.CGMinerAvalon1047 ::: pyasic.miners.btc.avalonminer.cgminer.A10X.A1047.CGMinerAvalon1047
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -19,7 +19,7 @@
## A1066 ## A1066
::: pyasic.miners.avalonminer.cgminer.A10X.A1066.CGMinerAvalon1066 ::: pyasic.miners.btc.avalonminer.cgminer.A10X.A1066.CGMinerAvalon1066
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false

6
docs/miners/avalonminer/A7X.md
View File

@@ -3,7 +3,7 @@
## A721 ## A721
::: pyasic.miners.avalonminer.cgminer.A7X.A721.CGMinerAvalon721 ::: pyasic.miners.btc.avalonminer.cgminer.A7X.A721.CGMinerAvalon721
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -11,7 +11,7 @@
## A741 ## A741
::: pyasic.miners.avalonminer.cgminer.A7X.A741.CGMinerAvalon741 ::: pyasic.miners.btc.avalonminer.cgminer.A7X.A741.CGMinerAvalon741
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -19,7 +19,7 @@
## A761 ## A761
::: pyasic.miners.avalonminer.cgminer.A7X.A761.CGMinerAvalon761 ::: pyasic.miners.btc.avalonminer.cgminer.A7X.A761.CGMinerAvalon761
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false

6
docs/miners/avalonminer/A8X.md
View File

@@ -3,7 +3,7 @@
## A821 ## A821
::: pyasic.miners.avalonminer.cgminer.A8X.A821.CGMinerAvalon821 ::: pyasic.miners.btc.avalonminer.cgminer.A8X.A821.CGMinerAvalon821
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -11,7 +11,7 @@
## A841 ## A841
::: pyasic.miners.avalonminer.cgminer.A8X.A841.CGMinerAvalon841 ::: pyasic.miners.btc.avalonminer.cgminer.A8X.A841.CGMinerAvalon841
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -19,7 +19,7 @@
## A851 ## A851
::: pyasic.miners.avalonminer.cgminer.A8X.A851.CGMinerAvalon851 ::: pyasic.miners.btc.avalonminer.cgminer.A8X.A851.CGMinerAvalon851
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false

2
docs/miners/avalonminer/A9X.md
View File

@@ -3,7 +3,7 @@
## A921 ## A921
::: pyasic.miners.avalonminer.cgminer.A9X.A921.CGMinerAvalon921 ::: pyasic.miners.btc.avalonminer.cgminer.A9X.A921.CGMinerAvalon921
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false

8
docs/miners/backends/bfgminer.md Normal file
View File

@@ -0,0 +1,8 @@
# pyasic
## BFGMiner Backend
::: pyasic.miners.kda._backends.bfgminer.BFGMiner
handler: python
options:
show_root_heading: false
heading_level: 4

2
docs/miners/backends/bmminer.md
View File

@@ -1,7 +1,7 @@
# pyasic # pyasic
## BMMiner Backend ## BMMiner Backend
::: pyasic.miners._backends.bmminer.BMMiner ::: pyasic.miners.btc._backends.bmminer.BMMiner
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false

2
docs/miners/backends/bosminer.md
View File

@@ -1,7 +1,7 @@
# pyasic # pyasic
## BOSMiner Backend ## BOSMiner Backend
::: pyasic.miners._backends.bosminer.BOSMiner ::: pyasic.miners.btc._backends.bosminer.BOSMiner
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false

2
docs/miners/backends/btminer.md
View File

@@ -1,7 +1,7 @@
# pyasic # pyasic
## BTMiner Backend ## BTMiner Backend
::: pyasic.miners._backends.btminer.BTMiner ::: pyasic.miners.btc._backends.btminer.BTMiner
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false

2
docs/miners/backends/cgminer.md
View File

@@ -1,7 +1,7 @@
# pyasic # pyasic
## CGMiner Backend ## CGMiner Backend
::: pyasic.miners._backends.cgminer.CGMiner ::: pyasic.miners.btc._backends.cgminer.CGMiner
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false

2
docs/miners/backends/hiveon.md
View File

@@ -1,7 +1,7 @@
# pyasic # pyasic
## Hiveon Backend ## Hiveon Backend
::: pyasic.miners._backends.hiveon.Hiveon ::: pyasic.miners.btc._backends.hiveon.Hiveon
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false

10
docs/miners/goldshell/CKX.md Normal file
View File

@@ -0,0 +1,10 @@
# pyasic
## CKX Models
## CK5
::: pyasic.miners.ckb.goldshell.bfgminer.CKX.CK5.BFGMinerCK5
handler: python
options:
show_root_heading: false
heading_level: 4

10
docs/miners/goldshell/HSX.md Normal file
View File

@@ -0,0 +1,10 @@
# pyasic
## HSX Models
## HS5
::: pyasic.miners.hns.goldshell.bfgminer.HSX.HS5.BFGMinerHS5
handler: python
options:
show_root_heading: false
heading_level: 4

19
docs/miners/goldshell/KDX.md Normal file
View File

@@ -0,0 +1,19 @@
# pyasic
## KDX Models
## KD5
::: pyasic.miners.kda.goldshell.bfgminer.KDX.KD5.BFGMinerKD5
handler: python
options:
show_root_heading: false
heading_level: 4
## KD Max
::: pyasic.miners.kda.goldshell.bfgminer.KDX.KDMax.BFGMinerKDMax
handler: python
options:
show_root_heading: false
heading_level: 4

10
docs/miners/innosilicon/A10X.md Normal file
View File

@@ -0,0 +1,10 @@
# pyasic
## A10X Models
## A10X
::: pyasic.miners.etc.innosilicon.cgminer.A10X.A10X.CGMinerA10X
handler: python
options:
show_root_heading: false
heading_level: 4

2
docs/miners/innosilicon/T3X.md
View File

@@ -3,7 +3,7 @@
## T3H+ ## T3H+
::: pyasic.miners.innosilicon.cgminer.T3X.T3H_Plus.CGMinerInnosiliconT3HPlus ::: pyasic.miners.btc.innosilicon.cgminer.T3X.T3H_Plus.CGMinerInnosiliconT3HPlus
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false

55
docs/miners/supported_types.md
View File

@@ -453,11 +453,36 @@ details {
</ul> </ul>
</details> </details>
<details> <details>
<summary>X15 Series:</summary>
<ul>
<li><a href="../antminer/X15/#z15">Z15</a></li>
</ul>
</details>
<details>
<summary>X9 Series:</summary> <summary>X9 Series:</summary>
<ul> <ul>
<li><a href="../antminer/X9/#s9">S9</a></li> <li><a href="../antminer/X9/#s9">S9</a></li>
<li><a href="../antminer/X9/#s9i">S9i</a></li> <li><a href="../antminer/X9/#s9i">S9i</a></li>
<li><a href="../antminer/X9/#t9">T9</a></li> <li><a href="../antminer/X9/#t9">T9</a></li>
<li><a href="../antminer/X9/#e9-pro">E9 Pro</a></li>
</ul>
</details>
<details>
<summary>X7 Series:</summary>
<ul>
<li><a href="../antminer/X7/#l7">L7</a></li>
</ul>
</details>
<details>
<summary>X5 Series:</summary>
<ul>
<li><a href="../antminer/X5/#dr5">DR5</a></li>
</ul>
</details>
<details>
<summary>X3 Series:</summary>
<ul>
<li><a href="../antminer/X3/#hs3">HS3</a></li>
</ul> </ul>
</details> </details>
</ul> </ul>
@@ -506,5 +531,35 @@ details {
<li><a href="../innosilicon/T3X/#t3h">T3H+</a></li> <li><a href="../innosilicon/T3X/#t3h">T3H+</a></li>
</ul> </ul>
</details> </details>
<details>
<summary>A10X Series:</summary>
<ul>
<li><a href="../innosilicon/A10X/#a10x">A10X</a></li>
</ul>
</details>
</ul>
</details>
<details>
<summary>Stock Firmware Goldshell Miners:</summary>
<ul>
<details>
<summary>CKX Series:</summary>
<ul>
<li><a href="../goldshell/CKX/#ck5">CK5</a></li>
</ul>
</details>
<details>
<summary>HSX Series:</summary>
<ul>
<li><a href="../goldshell/HSX/#hs5">HS5</a></li>
</ul>
</details>
<details>
<summary>KDX Series:</summary>
<ul>
<li><a href="../goldshell/KDX/#kd5">KD5</a></li>
<li><a href="../goldshell/KDX/#kd-max">KD Max</a></li>
</ul>
</details>
</ul> </ul>
</details> </details>

22
docs/miners/whatsminer/M2X.md
View File

@@ -3,7 +3,7 @@
## M20V10 ## M20V10
::: pyasic.miners.whatsminer.btminer.M2X.M20.BTMinerM20V10 ::: pyasic.miners.btc.whatsminer.btminer.M2X.M20.BTMinerM20V10
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -11,7 +11,7 @@
## M20SV10 ## M20SV10
::: pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20SV10 ::: pyasic.miners.btc.whatsminer.btminer.M2X.M20S.BTMinerM20SV10
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -19,7 +19,7 @@
## M20SV20 ## M20SV20
::: pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20SV20 ::: pyasic.miners.btc.whatsminer.btminer.M2X.M20S.BTMinerM20SV20
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -27,7 +27,7 @@
## M20SV30 ## M20SV30
::: pyasic.miners.whatsminer.btminer.M2X.M20S.BTMinerM20SV30 ::: pyasic.miners.btc.whatsminer.btminer.M2X.M20S.BTMinerM20SV30
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -35,7 +35,7 @@
## M20S+V30 ## M20S+V30
::: pyasic.miners.whatsminer.btminer.M2X.M20S_Plus.BTMinerM20SPlusV30 ::: pyasic.miners.btc.whatsminer.btminer.M2X.M20S_Plus.BTMinerM20SPlusV30
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -43,7 +43,7 @@
## M21V10 ## M21V10
::: pyasic.miners.whatsminer.btminer.M2X.M21.BTMinerM21V10 ::: pyasic.miners.btc.whatsminer.btminer.M2X.M21.BTMinerM21V10
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -51,7 +51,7 @@
## M21SV20 ## M21SV20
::: pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21SV20 ::: pyasic.miners.btc.whatsminer.btminer.M2X.M21S.BTMinerM21SV20
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -59,7 +59,7 @@
## M21SV60 ## M21SV60
::: pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21SV60 ::: pyasic.miners.btc.whatsminer.btminer.M2X.M21S.BTMinerM21SV60
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -67,7 +67,7 @@
## M21SV70 ## M21SV70
::: pyasic.miners.whatsminer.btminer.M2X.M21S.BTMinerM21SV70 ::: pyasic.miners.btc.whatsminer.btminer.M2X.M21S.BTMinerM21SV70
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -75,7 +75,7 @@
## M21S+V20 ## M21S+V20
::: pyasic.miners.whatsminer.btminer.M2X.M21S_Plus.BTMinerM21SPlusV20 ::: pyasic.miners.btc.whatsminer.btminer.M2X.M21S_Plus.BTMinerM21SPlusV20
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -83,7 +83,7 @@
## M29V10 ## M29V10
::: pyasic.miners.whatsminer.btminer.M2X.M29.BTMinerM29V10 ::: pyasic.miners.btc.whatsminer.btminer.M2X.M29.BTMinerM29V10
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false

274
docs/miners/whatsminer/M3X.md
View File

File diff suppressed because it is too large Load Diff

60
docs/miners/whatsminer/M5X.md
View File

@@ -3,7 +3,7 @@
## M50VG30 ## M50VG30
::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VG30 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M50.BTMinerM50VG30
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -11,7 +11,7 @@
## M50VH10 ## M50VH10
::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH10 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M50.BTMinerM50VH10
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -19,7 +19,7 @@
## M50VH20 ## M50VH20
::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH20 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M50.BTMinerM50VH20
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -27,7 +27,7 @@
## M50VH30 ## M50VH30
::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH30 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M50.BTMinerM50VH30
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -35,7 +35,7 @@
## M50VH40 ## M50VH40
::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH40 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M50.BTMinerM50VH40
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -43,7 +43,7 @@
## M50VH50 ## M50VH50
::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH50 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M50.BTMinerM50VH50
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -51,7 +51,7 @@
## M50VH60 ## M50VH60
::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH60 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M50.BTMinerM50VH60
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -59,7 +59,7 @@
## M50VH70 ## M50VH70
::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH70 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M50.BTMinerM50VH70
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -67,7 +67,7 @@
## M50VH80 ## M50VH80
::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VH80 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M50.BTMinerM50VH80
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -75,7 +75,7 @@
## M50VJ10 ## M50VJ10
::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VJ10 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M50.BTMinerM50VJ10
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -83,7 +83,7 @@
## M50VJ20 ## M50VJ20
::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VJ20 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M50.BTMinerM50VJ20
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -91,7 +91,7 @@
## M50VJ30 ## M50VJ30
::: pyasic.miners.whatsminer.btminer.M5X.M50.BTMinerM50VJ30 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M50.BTMinerM50VJ30
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -99,7 +99,7 @@
## M50SVJ10 ## M50SVJ10
::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVJ10 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M50S.BTMinerM50SVJ10
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -107,7 +107,7 @@
## M50SVJ20 ## M50SVJ20
::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVJ20 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M50S.BTMinerM50SVJ20
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -115,7 +115,7 @@
## M50SVJ30 ## M50SVJ30
::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVJ30 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M50S.BTMinerM50SVJ30
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -123,7 +123,7 @@
## M50SVH10 ## M50SVH10
::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVH10 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M50S.BTMinerM50SVH10
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -131,7 +131,7 @@
## M50SVH20 ## M50SVH20
::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVH20 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M50S.BTMinerM50SVH20
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -139,7 +139,7 @@
## M50SVH30 ## M50SVH30
::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVH30 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M50S.BTMinerM50SVH30
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -147,7 +147,7 @@
## M50SVH40 ## M50SVH40
::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVH40 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M50S.BTMinerM50SVH40
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -155,7 +155,7 @@
## M50SVH50 ## M50SVH50
::: pyasic.miners.whatsminer.btminer.M5X.M50S.BTMinerM50SVH50 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M50S.BTMinerM50SVH50
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -163,7 +163,7 @@
## M50S+VH30 ## M50S+VH30
::: pyasic.miners.whatsminer.btminer.M5X.M50S_Plus.BTMinerM50SPlusVH30 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M50S_Plus.BTMinerM50SPlusVH30
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -171,7 +171,7 @@
## M50S+VH40 ## M50S+VH40
::: pyasic.miners.whatsminer.btminer.M5X.M50S_Plus.BTMinerM50SPlusVH40 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M50S_Plus.BTMinerM50SPlusVH40
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -179,7 +179,7 @@
## M50S+VJ30 ## M50S+VJ30
::: pyasic.miners.whatsminer.btminer.M5X.M50S_Plus.BTMinerM50SPlusVJ30 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M50S_Plus.BTMinerM50SPlusVJ30
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -187,7 +187,7 @@
## M53VH30 ## M53VH30
::: pyasic.miners.whatsminer.btminer.M5X.M53.BTMinerM53VH30 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M53.BTMinerM53VH30
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -195,7 +195,7 @@
## M53SVH30 ## M53SVH30
::: pyasic.miners.whatsminer.btminer.M5X.M53S.BTMinerM53SVH30 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M53S.BTMinerM53SVH30
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -203,7 +203,7 @@
## M53S+VJ30 ## M53S+VJ30
::: pyasic.miners.whatsminer.btminer.M5X.M53S_Plus.BTMinerM53SPlusVJ30 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M53S_Plus.BTMinerM53SPlusVJ30
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -211,7 +211,7 @@
## M56VH30 ## M56VH30
::: pyasic.miners.whatsminer.btminer.M5X.M56.BTMinerM56VH30 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M56.BTMinerM56VH30
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -219,7 +219,7 @@
## M56SVH30 ## M56SVH30
::: pyasic.miners.whatsminer.btminer.M5X.M56S.BTMinerM56SVH30 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M56S.BTMinerM56SVH30
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -227,7 +227,7 @@
## M56S+VJ30 ## M56S+VJ30
::: pyasic.miners.whatsminer.btminer.M5X.M56S_Plus.BTMinerM56SPlusVJ30 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M56S_Plus.BTMinerM56SPlusVJ30
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false
@@ -235,7 +235,7 @@
## M59VH30 ## M59VH30
::: pyasic.miners.whatsminer.btminer.M5X.M59.BTMinerM59VH30 ::: pyasic.miners.btc.whatsminer.btminer.M5X.M59.BTMinerM59VH30
handler: python handler: python
options: options:
show_root_heading: false show_root_heading: false

9
mkdocs.yml
View File

@@ -8,11 +8,16 @@ nav:
- Backends: - Backends:
- BMMiner: "miners/backends/bmminer.md" - BMMiner: "miners/backends/bmminer.md"
- BOSMiner: "miners/backends/bosminer.md" - BOSMiner: "miners/backends/bosminer.md"
- BFGMiner: "miners/backends/bfgminer.md"
- BTMiner: "miners/backends/btminer.md" - BTMiner: "miners/backends/btminer.md"
- CGMiner: "miners/backends/cgminer.md" - CGMiner: "miners/backends/cgminer.md"
- Hiveon: "miners/backends/hiveon.md" - Hiveon: "miners/backends/hiveon.md"
- Classes: - Classes:
- Antminer X3: "miners/antminer/X3.md"
- Antminer X5: "miners/antminer/X5.md"
- Antminer X7: "miners/antminer/X7.md"
- Antminer X9: "miners/antminer/X9.md" - Antminer X9: "miners/antminer/X9.md"
- Antminer X15: "miners/antminer/X15.md"
- Antminer X17: "miners/antminer/X17.md" - Antminer X17: "miners/antminer/X17.md"
- Antminer X19: "miners/antminer/X19.md" - Antminer X19: "miners/antminer/X19.md"
- Avalon 7X: "miners/avalonminer/A7X.md" - Avalon 7X: "miners/avalonminer/A7X.md"
@@ -23,6 +28,10 @@ nav:
- Whatsminer M3X: "miners/whatsminer/M3X.md" - Whatsminer M3X: "miners/whatsminer/M3X.md"
- Whatsminer M5X: "miners/whatsminer/M5X.md" - Whatsminer M5X: "miners/whatsminer/M5X.md"
- Innosilicon T3X: "miners/innosilicon/T3X.md" - Innosilicon T3X: "miners/innosilicon/T3X.md"
- Innosilicon A10X: "miners/innosilicon/A10X.md"
- Goldshell CKX: "miners/goldshell/CKX.md"
- Goldshell HSX: "miners/goldshell/HSX.md"
- Goldshell KDX: "miners/goldshell/KDX.md"
- Network: - Network:
- Miner Network: "network/miner_network.md" - Miner Network: "network/miner_network.md"
- Miner Network Range: "network/miner_network_range.md" - Miner Network Range: "network/miner_network_range.md"

2
pyasic/miners/btc/_backends/bosminer.py
View File

@@ -136,7 +136,7 @@ class BOSMiner(BaseMiner):
return False return False
async def restart_backend(self) -> bool: async def restart_backend(self) -> bool:
"""Restart bosminer hashing process. Wraps [`restart_bosminer`][pyasic.miners._backends.bosminer.BOSMiner.restart_bosminer] to standardize.""" """Restart bosminer hashing process. Wraps [`restart_bosminer`][pyasic.miners.btc._backends.bosminer.BOSMiner.restart_bosminer] to standardize."""
return await self.restart_bosminer() return await self.restart_bosminer()
async def restart_bosminer(self) -> bool: async def restart_bosminer(self) -> bool:

2
pyasic/miners/btc/_backends/cgminer.py
View File

@@ -69,7 +69,7 @@ class CGMiner(BaseMiner):
return result return result
async def restart_backend(self) -> bool: async def restart_backend(self) -> bool:
"""Restart cgminer hashing process. Wraps [`restart_cgminer`][pyasic.miners._backends.cgminer.CGMiner.restart_cgminer] to standardize.""" """Restart cgminer hashing process. Wraps [`restart_cgminer`][pyasic.miners.btc._backends.cgminer.CGMiner.restart_cgminer] to standardize."""
return await self.restart_cgminer() return await self.restart_cgminer()
async def restart_cgminer(self) -> bool: async def restart_cgminer(self) -> bool: