mirror of
https://github.com/OMGeeky/flucto-heisskleber.git
synced 2026-02-23 15:38:33 +01:00
Add autodoc references and fix broker
This commit is contained in:
@@ -6,6 +6,7 @@ extensions = [
|
||||
"sphinx.ext.autodoc",
|
||||
"sphinx.ext.napoleon",
|
||||
"myst_parser",
|
||||
]
|
||||
] # , "autodoc2"
|
||||
# autodoc2_packages = ["../heisskleber"]
|
||||
autodoc_typehints = "description"
|
||||
html_theme = "furo"
|
||||
|
||||
@@ -1,8 +1,40 @@
|
||||
# Reference
|
||||
|
||||
## heisskleber
|
||||
## Network
|
||||
|
||||
```{eval-rst}
|
||||
.. automodule:: heisskleber
|
||||
.. automodule:: heisskleber.network
|
||||
:members:
|
||||
.. automodule:: heisskleber.network.mqtt
|
||||
.. autoclass:: MqttPublisher
|
||||
.. autoclass:: MqttSubscriber
|
||||
.. automodule:: heisskleber.network.zmq
|
||||
:members:
|
||||
.. autoclass:: ZmqPublisher
|
||||
.. autoclass:: ZmqSubscriber
|
||||
```
|
||||
|
||||
### Broker
|
||||
|
||||
```{eval-rst}
|
||||
.. automodule:: heisskleber.broker
|
||||
:members:
|
||||
```
|
||||
|
||||
## Config
|
||||
|
||||
### Loading configs
|
||||
```{eval-rst}
|
||||
.. automodule:: heisskleber.config
|
||||
:members: load_config
|
||||
```
|
||||
|
||||
### Config types
|
||||
|
||||
Configs are extended dataclasses, which inherit from the BaseConf class.
|
||||
```{eval-rst}
|
||||
.. autoclass:: heisskleber.config.BaseConf
|
||||
.. autoclass:: heisskleber.network.mqtt.config.MqttConf
|
||||
.. autoclass:: heisskleber.network.zmq.config.ZmqConf
|
||||
.. autoclass:: heisskleber.network.serial.config.SerialConf
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user