From 775f41e195e704e3628500556b9fc4f96274db6c Mon Sep 17 00:00:00 2001 From: Ross Patterson Date: Tue, 19 Aug 2025 02:33:53 -0700 Subject: [PATCH] docs(preset): Config file top presets vs base --- docs/source/config_reference/config_yaml.rst | 25 +++++++++++++------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/docs/source/config_reference/config_yaml.rst b/docs/source/config_reference/config_yaml.rst index 28a8d3bc..797ed4e6 100644 --- a/docs/source/config_reference/config_yaml.rst +++ b/docs/source/config_reference/config_yaml.rst @@ -2,10 +2,6 @@ Configuration File ================== - -config.yaml ------------ - ytdl-sub is configured using a ``config.yaml`` file. The ``config.yaml`` is made up of two sections: @@ -57,12 +53,25 @@ Log files are stored as presets ------- -``presets`` define a `formula` for how to format downloaded media and metadata. +Each key under ``presets:`` defines a `formula` for how to format downloaded media and +metadata. The key is the name of the preset and the value is a mapping that defines the +preset. -This section is work-in-progress! +.. note:: -preset -~~~~~~ + The ``presets:`` key at the top of the configuration file contains multiple + user-defined presets, but *each preset* itself may include a ``presets:`` key that + defines *that preset's* base presets. For example: + + .. code-block:: yaml + + presets: + Foo Preset: + presets: + - "Jellyfin TV Show by Date" + +presets +~~~~~~~ Presets support inheritance by defining a parent preset: