Added UML generation to mkdocs generation

This commit is contained in:
Cian Hughes
2023-12-18 17:11:14 +00:00
parent fbbde8012d
commit c77c9374ec
8 changed files with 90 additions and 7 deletions

14
docs/assets/classes.mmd Normal file
View File

@@ -0,0 +1,14 @@
classDiagram
class Config {
apply_config(config: dict) None
finalise_config(config: dict) None
get_config(config_label: ConfigLabel) dict
update_config(config_label: ConfigLabel) None
}
class IPAddress {
obj : IPv4Address | IPv6Address
}
class Singleton {
}
class SingletonProgress {
}

49
docs/assets/packages.mmd Normal file
View File

@@ -0,0 +1,49 @@
classDiagram
class node_deployer {
}
class __main__ {
}
class autoignition {
}
class cli {
}
class config {
}
class create_disk {
}
class create_img {
}
class debug {
}
class ip_interface {
}
class node_deployer {
}
class utils {
}
__main__ --> config
__main__ --> node_deployer
autoignition --> cli
autoignition --> config
autoignition --> debug
autoignition --> utils
cli --> config
cli --> utils
create_disk --> cli
create_disk --> config
create_disk --> create_img
create_disk --> debug
create_disk --> ip_interface
create_disk --> utils
create_img --> autoignition
create_img --> cli
create_img --> config
create_img --> debug
create_img --> ip_interface
create_img --> utils
debug --> config
node_deployer --> autoignition
node_deployer --> config
node_deployer --> create_disk
node_deployer --> create_img
utils --> config

View File

@@ -27,7 +27,7 @@ This configuration keeps all computations local to the machine on which the tool
| FUELIGNITION_URL | "http://localhost:3000/fuel-ignition/edit" | str |
## remote
<p>This configuration allows the use of hosted websites for hte fuel-ignition configurator.</p>
<p>This configuration allows the use of hosted websites for the fuel-ignition configurator.</p>
<p>Currently, this configuration is broken/deprecated. It is being kept as it may be be reimplemented in the future as part of a dockerless configuration.</p>
| Variable | Value | Type |

9
docs/uml.md Normal file
View File

@@ -0,0 +1,9 @@
# Packages
```mermaid
{% include "assets/packages.mmd" %}
```
# Classes
```mermaid
{% include "assets/classes.mmd" %}
```