Auto update toml file by adding a script for sphinx docs

[I-Need-Sleep-Asap]

No description provided.

[I-Need-Sleep-Asap]

Newly generated html with this code looks as
configuration.html

[I-Need-Sleep-Asap]

my initial solution was to hardcode this logic but decided to opt for this to make it robust incase directory structure change in future

[rafa-be]

Do not forget to add the generated config file to the .gitignore.

[rafa-be]

I'd prefer if we checked the section classes based on being a sub-classes of a Config mixin, instead of relying on dataclasses.

[I-Need-Sleep-Asap]

@rafa-be : To make this work, we need to introduce a marker class (lets name it ConfigSection) & make all Config classes such as ClusterConfig, SchedulerConfig etc to inherit from it. By inheriting from ConfigSection, a class is clearly designated for inclusion in the generated TOML configuration. This "opt-in" approach ensures the script only targets the intended classes without relying on implementation details or location.

However, @sharpener6 is very strict about using inheritance & i dont think this warrants the strict requirements. Please lemme know your thoughts

[I-Need-Sleep-Asap]

I can think of other ways.
Using decorators

def config_section(cls):
    cls._is_config_section = True  # Add an attribute to the class
    return cls

@config_section  # Apply the decorator right above the class definition
@dataclasses.dataclass
class ClusterConfig:
......

another idea is to use class atribute:

@dataclasses.dataclass
class ClusterConfig:
    _is_config_section = True  # Manually add the marker attribute
    
    scheduler_address: ZMQConfig
    # ... rest of the class