docs: update documentation to include new web docstrings.

docs/index.md

@@ -22,13 +22,16 @@ Welcome to `pyasic`!  `pyasic` uses an asynchronous method of communicating with
 ## Installation
 
 It is recommended to install `pyasic` in a [virtual environment](https://realpython.com/python-virtual-environments-a-primer/#what-other-popular-options-exist-aside-from-venv) to isolate it from the rest of your system. Options include:
+
   - [venv](https://docs.python.org/3/library/venv.html): included in Python standard library but has fewer features than other options
   - [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv): [pyenv](https://github.com/pyenv/pyenv) plugin for managing virtualenvs
-    ```
+    
+```
     pyenv install <python version number>
     pyenv virtualenv <python version number> <env name>
     pyenv activate <env name>
-    ```
+```
+
   - [conda](https://docs.conda.io/en/latest/)
 
 ##### Installing `pyasic`

docs/miners/miner_factory.md

@@ -1,11 +1,11 @@
 # pyasic
 ## Miner Factory
 
-[`MinerFactory`][pyasic.MinerFactory] is the way to create miner types in `pyasic`.  The most important method is [`get_miner()`][pyasic.get_miner], which is mapped to [`pyasic.get_miner()`][pyasic.get_miner], and should be used from there.
+[`MinerFactory`][pyasic.miners.factory.MinerFactory] is the way to create miner types in `pyasic`.  The most important method is [`get_miner()`][pyasic.get_miner], which is mapped to [`pyasic.get_miner()`][pyasic.get_miner], and should be used from there.
 
 The instance used for [`pyasic.get_miner()`][pyasic.get_miner] is `pyasic.miner_factory`.
 
-[`MinerFactory`][pyasic.MinerFactory] also keeps a cache, which can be cleared if needed with `pyasic.miner_factory.clear_cached_miners()`.
+[`MinerFactory`][pyasic.miners.factory.MinerFactory] also keeps a cache, which can be cleared if needed with `pyasic.miner_factory.clear_cached_miners()`.
 
 Finally, there is functionality to get multiple miners without using `asyncio.gather()` explicitly.  Use `pyasic.miner_factory.get_multiple_miners()` with a list of IPs as strings to get a list of miner instances.  You can also get multiple miners with an `AsyncGenerator` by using `pyasic.miner_factory.get_miner_generator()`.
 
@@ -32,5 +32,5 @@ Finally, there is functionality to get multiple miners without using `asyncio.ga
         heading_level: 4
 
 [`AnyMiner`][pyasic.miners.base.AnyMiner] is a placeholder type variable used for typing returns of functions.
-A function returning [`AnyMiner`][pyasic.miners.base.AnyMiner] will always return a subclass of [`BaseMiner`][pyasic.miners.BaseMiner],
+A function returning [`AnyMiner`][pyasic.miners.base.AnyMiner] will always return a subclass of [`BaseMiner`][pyasic.miners.base.BaseMiner],
 and is used to specify a function returning some arbitrary type of miner class instance.

docs/rpc/api.md

@@ -1,10 +1,10 @@
 # pyasic
-## Miner APIs
+## Miner RPC APIs
-Each miner has a unique API that is used to communicate with it.
+Each miner has a unique RPC 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`][pyasic.miners.BaseMiner] should have an API linked to it as `Miner.api`.
+Each miner that is a subclass of [`BaseMiner`][pyasic.miners.base.BaseMiner] may have an API linked to it as `Miner.rpc`.
 
-All API implementations inherit from [`BaseMinerRPCAPI`][pyasic.rpc.base.BaseMinerRPCAPI], which implements the basic communications protocols.
+All RPC API implementations inherit from [`BaseMinerRPCAPI`][pyasic.rpc.base.BaseMinerRPCAPI], which implements the basic communications protocols.
 
 [`BaseMinerRPCAPI`][pyasic.rpc.base.BaseMinerRPCAPI] should never be used unless inheriting to create a new miner API class for a new type of miner (which should be exceedingly rare).
 [`BaseMinerRPCAPI`][pyasic.rpc.base.BaseMinerRPCAPI] cannot be instantiated directly, it will raise a `TypeError`.

docs/web/antminer.md

@@ -0,0 +1,14 @@
+# pyasic
+## AntminerModernWebAPI
+::: pyasic.web.antminer.AntminerModernWebAPI
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4
+
+## AntminerOldWebAPI
+::: pyasic.web.antminer.AntminerOldWebAPI
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/web/api.md

@@ -0,0 +1,27 @@
+# pyasic
+## Miner Web APIs
+Each miner has a unique Web 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`][pyasic.miners.base.BaseMiner] may have an API linked to it as `Miner.web`.
+
+All API implementations inherit from [`BaseWebAPI`][pyasic.web.BaseWebAPI], which implements the basic communications protocols.
+
+[`BaseWebAPI`][pyasic.web.BaseWebAPI] should never be used unless inheriting to create a new miner API class for a new type of miner (which should be exceedingly rare).
+Use these instead -
+
+#### [AntminerModerNWebAPI][pyasic.web.antminer.AntminerModernWebAPI]
+#### [AntminerOldWebAPI][pyasic.web.antminer.AntminerOldWebAPI]
+#### [AuradineWebAPI][pyasic.web.auradine.AuradineWebAPI]
+#### [ePICWebAPI][pyasic.web.epic.ePICWebAPI]
+#### [GoldshellWebAPI][pyasic.web.goldshell.GoldshellWebAPI]
+#### [InnosiliconWebAPI][pyasic.web.innosilicon.InnosiliconWebAPI]
+#### [MaraWebAPI][pyasic.web.marathon.MaraWebAPI]
+#### [VNishWebAPI][pyasic.web.vnish.VNishWebAPI]
+
+<br>
+
+## BaseWebAPI
+::: pyasic.web.BaseWebAPI
+    handler: python
+    options:
+        heading_level: 4

docs/web/auradine.md

@@ -0,0 +1,7 @@
+# pyasic
+## AuradineWebAPI
+::: pyasic.web.auradine.AuradineWebAPI
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/web/epic.md

@@ -0,0 +1,7 @@
+# pyasic
+## ePICWebAPI
+::: pyasic.web.epic.ePICWebAPI
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/web/goldshell.md

@@ -0,0 +1,7 @@
+# pyasic
+## GoldshellWebAPI
+::: pyasic.web.goldshell.GoldshellWebAPI
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/web/innosilicon.md

@@ -0,0 +1,7 @@
+# pyasic
+## InnosiliconWebAPI
+::: pyasic.web.innosilicon.InnosiliconWebAPI
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/web/marathon.md

@@ -0,0 +1,7 @@
+# pyasic
+## MaraWebAPI
+::: pyasic.web.marathon.MaraWebAPI
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

docs/web/vnish.md

@@ -0,0 +1,7 @@
+# pyasic
+## VNishWebAPI
+::: pyasic.web.vnish.VNishWebAPI
+    handler: python
+    options:
+        show_root_heading: false
+        heading_level: 4

mkdocs.yml

@@ -22,6 +22,15 @@ nav:
         - CGMiner: "rpc/cgminer.md"
         - LUXMiner: "rpc/luxminer.md"
         - Unknown: "rpc/unknown.md"
+    - Web APIs:
+        - Intro: "web/api.md"
+        - Antminer: "web/antminer.md"
+        - Auradine: "web/auradine.md"
+        - ePIC: "web/epic.md"
+        - Goldshell: "web/goldshell.md"
+        - Innosilicon: "web/innosilicon.md"
+        - Marathon: "web/marathon.md"
+        - VNish: "web/vnish.md"
     - Backends:
         - BMMiner: "miners/backends/bmminer.md"
         - BOSMiner: "miners/backends/bosminer.md"
@@ -50,10 +59,15 @@ nav:
         - Whatsminer M2X: "miners/whatsminer/M2X.md"
         - Whatsminer M3X: "miners/whatsminer/M3X.md"
         - Whatsminer M5X: "miners/whatsminer/M5X.md"
+        - Whatsminer M6X: "miners/whatsminer/M6X.md"
         - Innosilicon T3X: "miners/innosilicon/T3X.md"
         - Innosilicon A10X: "miners/innosilicon/A10X.md"
         - Goldshell X5: "miners/goldshell/X5.md"
         - Goldshell XMax: "miners/goldshell/XMax.md"
+        - Goldshell XBox: "miners/goldshell/XBox.md"
+        - Auradine AD: "miners/auradine/AD.md"
+        - Auradine AI: "miners/auradine/AI.md"
+        - Auradine AT: "miners/auradine/AT.md"
     - Base Miner: "miners/base_miner.md"
 - Settings:
       - Settings: "settings/settings.md"

pyasic/web/__init__.py

@@ -13,6 +13,8 @@
 #  See the License for the specific language governing permissions and         -
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
+from .base import BaseWebAPI
+
 from .antminer import AntminerModernWebAPI, AntminerOldWebAPI
 from .auradine import AuradineWebAPI
 from .braiins_os import BOSerWebAPI, BOSMinerWebAPI