diff --git a/docs/source/config_reference/config_yaml.rst b/docs/source/config_reference/config_yaml.rst index 2acce069..c3fab0c7 100644 --- a/docs/source/config_reference/config_yaml.rst +++ b/docs/source/config_reference/config_yaml.rst @@ -109,3 +109,13 @@ working_directory ----------------- The directory to temporarily store downloaded files before moving them into their final directory. (default ``./.ytdl-sub-working-directory``) + +Presets +======= +Hmmmm + +``name`` + +Returns +------- +Name of the preset diff --git a/src/ytdl_sub/config/preset.py b/src/ytdl_sub/config/preset.py index b89e1d53..5c3f2ea6 100644 --- a/src/ytdl_sub/config/preset.py +++ b/src/ytdl_sub/config/preset.py @@ -55,6 +55,10 @@ class _PresetShell(StrictDictValidator): class Preset(_PresetShell): + """ + Hmmmm + """ + @classmethod def preset_partial_validate(cls, config: ConfigValidator, name: str, value: Any) -> None: """ diff --git a/tools/docgen/configuration.py b/tools/docgen/configuration.py index 530db685..39fe92e1 100644 --- a/tools/docgen/configuration.py +++ b/tools/docgen/configuration.py @@ -3,6 +3,7 @@ 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 +from ytdl_sub.config.preset import Preset class ConfigurationDocGen(DocGen): @@ -23,4 +24,13 @@ class ConfigurationDocGen(DocGen): property_sections=True, ) + docs += generate_options_validator_docs( + name="Presets", + options=Preset, + offset=0, + skip_properties=False, + recurse_property_options=False, + property_sections=False + ) + return docs