ytdl-sub/docs
Jesse Bannon c255f40348
[FEATURE] Subscription nesting (#747)
Closes Feature Request: https://github.com/jmbannon/ytdl-sub/issues/743

Subscriptions support using presets as keys, and using keys to set override variables as values.
For example:

```
tv_show:
  only_recent:
    [News]:
      "Breaking News": "https://www.youtube.com/@SomeBreakingNews"

  [Tech]:
    "Two Minute Papers": "https://www.youtube.com/@TwoMinutePapers"
```
Will create two subscriptions named "Breaking News" and "Two Minute Papers", equivalent to:

```
"Breaking News":
  preset:
    - "tv_show"
    - "only_recent"

  overrides:
    subscription_indent_1: "News"
    subscription_name: "Breaking News"
    subscription_value: "https://www.youtube.com/@SomeBreakingNews"

"Two Minute Papers":
  preset:
    - "tv_show"

  overrides:
    subscription_indent_1: "Tech"
    subscription_name: "Two Minute Papers"     subscription_value: "https://www.youtube.com/@TwoMinutePapers"
```

You can provide as many parent presets in the form of keys, and subscription indents as ``[keys]``.
This can drastically simplify subscription definitions by setting things you want configurable like so in your
parent preset:

```
presets:
  tv_show_name:
    overrides:
      tv_show_name: "{subscription_name}"
      url: "{subscription_value}"
      genre: "{subscription_indent_1}"
```

NOTE!!!
Changing your subscription name from 'legacy' subscriptions will need their download archive file migrated to a new name. A future update will assist in this migration process. Either wait until then or, if you consider yourself a ytdl-sub expert, keep a backup of your subscription file before migrating.
2023-10-02 16:07:48 -07:00
..
conf.py Add documentation for plugins + improve docs overall (#23) 2022-05-10 22:22:03 -07:00
config.rst [FEATURE] Subscription nesting (#747) 2023-10-02 16:07:48 -07:00
deprecation_notices.rst [FEATURE] Subscription nesting (#747) 2023-10-02 16:07:48 -07:00
getting_started.rst [DOCS] readthedocs makeover (#493) 2023-03-01 23:45:16 -08:00
index.rst [FEATURE] Ability to add subscription value via config (#744) 2023-09-27 21:37:36 -07:00
install.rst [DOCS] Add unraid to readthedocs install (#580) 2023-04-05 12:34:00 -07:00
make.bat sphinx working 2022-04-13 07:47:33 +00:00
Makefile sphinx working 2022-04-13 07:47:33 +00:00
presets.rst [FEATURE] Add max_1080p prebuilt preset (#690) 2023-08-30 11:28:58 -07:00
usage.rst [FEATURE] Ability to suppress or write transaction log to file (#514) 2023-03-08 13:32:07 -08:00