add bmminer docs

2022-07-13 09:13:21 -06:00
parent 5700bd1c9c
commit 0324a21e79
3 changed files with 339 additions and 129 deletions
--- a/docs/api.md
+++ b/docs/api.md
@@ -0,0 +1,14 @@
+# pyasic
+## Miner APIs
+Each miner has a unique API that is used to communicate with it.
+Each of these API types has commands that differ between them, and some commands have data that others do not.
+Each miner that is a subclass of `BaseMiner` should have an API linked to it as `Miner.api`.
+
+All API implementations inherit from `BaseMinerAPI`, which implements the basic communications protocols.
+
+## BMMinerAPI
+::: pyasic.API.bmminer.BMMinerAPI
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4