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

[DOCS] Overhaul configuration file getting started guide

Browse source
This commit is contained in:
Jesse Bannon 2025-02-04 23:53:37 -08:00
parent 8d992cbcab
commit db106b37ad
1 changed files with 24 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
docs/source/guides/getting_started/first_config.rst
View file

@ -3,12 +3,31 @@ Basic Configuration
A configuration file serves two purposes: A configuration file serves two purposes:
1. Set advanced functionality that is not specifiable in a subscription file, such as working directory location. These 1. Set application-level functionality that is not specifiable in a subscription file.
are set underneath ``configuration``. .. note::
2. Create custom presets, which can drastically simplify your subscription file. These are defined underneath ``presets``.
Presets are intended to be applicable and reusable across multiple subscriptions.
Below is a common configuration: ytdl-sub does not require a configuration file. However,
certain application settings may be desirable for tweak, such as setting
``working_directory`` to make ytdl-sub perform the initial download
to an SSD drive.
2. Create custom presets.
.. note::
In the prior Initial Subscription examples, we leveraged the prebuilt preset
``Jellyfin TV Show by Date``. This preset is entirely built using the same
YAML configuration system offered to users by using a configuration file.
The following section attempts to demystify and explain how to...
- Set an application setting
- Know whether or not custom presets are actually needed
- How to create a custom preset
- How to use a custom preset on subscriptions
-------------
how this works, and show-case how
.. code-block:: yaml .. code-block:: yaml
:linenos: :linenos: