from pathlib import Path

from tools.docgen.docgen import DocGen
from tools.docgen.utils import generate_options_validator_docs
from ytdl_sub.config.config_validator import ConfigOptions


class ConfigurationDocGen(DocGen):

    LOCATION = Path("docs/source/config_reference/config_yaml.rst")

    @classmethod
    def generate(cls):
        docs = generate_options_validator_docs(
            name="Configuration File",
            options=ConfigOptions,
            offset=0,
            skip_properties=False,
            recurse_property_options=True,
            property_sections=True
        )

        return docs