Add autodoc references and fix broker

This commit is contained in:
Felix Weiler
2023-11-03 17:40:02 +01:00
parent 8b44b61998
commit 6e53cbbf2a
4 changed files with 102 additions and 3 deletions

View File

@@ -6,6 +6,7 @@ extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"myst_parser",
]
] # , "autodoc2"
# autodoc2_packages = ["../heisskleber"]
autodoc_typehints = "description"
html_theme = "furo"

View File

@@ -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
```