From 0c17ea0a9ae7378f7a18bc6424b5edc9e1f931ff Mon Sep 17 00:00:00 2001 From: Jesse Bannon Date: Mon, 16 Feb 2026 23:37:30 -0800 Subject: [PATCH] keep beginning --- docs/source/config_reference/config_yaml.rst | 15 ++++++++++++++- src/ytdl_sub/config/config_validator.py | 15 ++++++++++++++- 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/docs/source/config_reference/config_yaml.rst b/docs/source/config_reference/config_yaml.rst index 3332988d..37e9c158 100644 --- a/docs/source/config_reference/config_yaml.rst +++ b/docs/source/config_reference/config_yaml.rst @@ -8,7 +8,20 @@ Configuration File ================== -Something +ytdl-sub is configured using a ``config.yaml`` file. + +The ``config.yaml`` is made up of two sections: + +.. code-block:: yaml + + configuration: + presets: + + +Note for Windows users, paths can be represented with ``C:/forward/slashes/like/linux``. +If you prefer to use a Windows backslash, note that it must have +``C:\double\bashslash\paths`` in order to escape the backslash character. This is due to +it being a YAML escape character. dl_aliases ---------- diff --git a/src/ytdl_sub/config/config_validator.py b/src/ytdl_sub/config/config_validator.py index accc4b46..c9259809 100644 --- a/src/ytdl_sub/config/config_validator.py +++ b/src/ytdl_sub/config/config_validator.py @@ -113,7 +113,20 @@ class PersistLogsValidator(StrictDictValidator): class ConfigOptions(StrictDictValidator): """ - Something + ytdl-sub is configured using a ``config.yaml`` file. + + The ``config.yaml`` is made up of two sections: + + .. code-block:: yaml + + configuration: + presets: + + + Note for Windows users, paths can be represented with ``C:/forward/slashes/like/linux``. + If you prefer to use a Windows backslash, note that it must have + ``C:\\double\\bashslash\\paths`` in order to escape the backslash character. This is due to + it being a YAML escape character. """ _optional_keys = {