preset docs
This commit is contained in:
parent
d8189925b8
commit
e98149df15
3 changed files with 24 additions and 0 deletions
|
|
@ -109,3 +109,13 @@ working_directory
|
||||||
-----------------
|
-----------------
|
||||||
The directory to temporarily store downloaded files before moving them into their final
|
The directory to temporarily store downloaded files before moving them into their final
|
||||||
directory. (default ``./.ytdl-sub-working-directory``)
|
directory. (default ``./.ytdl-sub-working-directory``)
|
||||||
|
|
||||||
|
Presets
|
||||||
|
=======
|
||||||
|
Hmmmm
|
||||||
|
|
||||||
|
``name``
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
Name of the preset
|
||||||
|
|
|
||||||
|
|
@ -55,6 +55,10 @@ class _PresetShell(StrictDictValidator):
|
||||||
|
|
||||||
|
|
||||||
class Preset(_PresetShell):
|
class Preset(_PresetShell):
|
||||||
|
"""
|
||||||
|
Hmmmm
|
||||||
|
"""
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def preset_partial_validate(cls, config: ConfigValidator, name: str, value: Any) -> None:
|
def preset_partial_validate(cls, config: ConfigValidator, name: str, value: Any) -> None:
|
||||||
"""
|
"""
|
||||||
|
|
|
||||||
|
|
@ -3,6 +3,7 @@ from pathlib import Path
|
||||||
from tools.docgen.docgen import DocGen
|
from tools.docgen.docgen import DocGen
|
||||||
from tools.docgen.utils import generate_options_validator_docs
|
from tools.docgen.utils import generate_options_validator_docs
|
||||||
from ytdl_sub.config.config_validator import ConfigOptions
|
from ytdl_sub.config.config_validator import ConfigOptions
|
||||||
|
from ytdl_sub.config.preset import Preset
|
||||||
|
|
||||||
|
|
||||||
class ConfigurationDocGen(DocGen):
|
class ConfigurationDocGen(DocGen):
|
||||||
|
|
@ -23,4 +24,13 @@ class ConfigurationDocGen(DocGen):
|
||||||
property_sections=True,
|
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
|
return docs
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue