danvics/ytdl-sub
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(preset): Config file top presets vs base

Browse source
This commit is contained in:
Ross Patterson 2025-08-19 02:33:53 -07:00
parent 60ff645750
commit 775f41e195
No known key found for this signature in database
GPG key ID: 2EFF7CCE6828E359
1 changed files with 17 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
docs/source/config_reference/config_yaml.rst
View file

@ -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: