From e3c4f960742c9c19609188ffd8cbb3a46c807768 Mon Sep 17 00:00:00 2001 From: Qualis Svagtlys <45446348+Svagtlys@users.noreply.github.com> Date: Fri, 22 Dec 2023 19:03:16 -0600 Subject: [PATCH] Literal include of prebuilt preset files, proof of concept --- docs/source/config_reference/index.rst | 9 +++++---- .../prebuilt_presets/helpers_common.rst | 7 +++++++ .../prebuilt_presets/helpers_players.rst | 7 +++++++ .../prebuilt_presets/helpers_url.rst | 7 +++++++ .../config_reference/prebuilt_presets/index.rst | 12 ++++++++++++ docs/source/prebuilt_presets/tv_shows.rst | 15 ++++++--------- 6 files changed, 44 insertions(+), 13 deletions(-) create mode 100644 docs/source/config_reference/prebuilt_presets/helpers_common.rst create mode 100644 docs/source/config_reference/prebuilt_presets/helpers_players.rst create mode 100644 docs/source/config_reference/prebuilt_presets/helpers_url.rst create mode 100644 docs/source/config_reference/prebuilt_presets/index.rst diff --git a/docs/source/config_reference/index.rst b/docs/source/config_reference/index.rst index ee50572e..daea6857 100644 --- a/docs/source/config_reference/index.rst +++ b/docs/source/config_reference/index.rst @@ -1,6 +1,6 @@ -================ -Config Reference -================ +========= +Reference +========= This section contains direct references to the code of ``ytdl-sub`` and information on how it functions. @@ -8,4 +8,5 @@ This section contains direct references to the code of ``ytdl-sub`` and informat config_yaml subscriptions_yaml plugins - scripting/index \ No newline at end of file + scripting/index + prebuilt_presets/index \ No newline at end of file diff --git a/docs/source/config_reference/prebuilt_presets/helpers_common.rst b/docs/source/config_reference/prebuilt_presets/helpers_common.rst new file mode 100644 index 00000000..3dc5e105 --- /dev/null +++ b/docs/source/config_reference/prebuilt_presets/helpers_common.rst @@ -0,0 +1,7 @@ +======================= +Common Preset Reference +======================= + +.. highlight:: yaml + +.. literalinclude:: /../../src/ytdl_sub/prebuilt_presets/helpers/common.yaml diff --git a/docs/source/config_reference/prebuilt_presets/helpers_players.rst b/docs/source/config_reference/prebuilt_presets/helpers_players.rst new file mode 100644 index 00000000..404c38ab --- /dev/null +++ b/docs/source/config_reference/prebuilt_presets/helpers_players.rst @@ -0,0 +1,7 @@ +======================== +Players Preset Reference +======================== + +.. highlight:: yaml + +.. literalinclude:: /../../src/ytdl_sub/prebuilt_presets/helpers/players.yaml diff --git a/docs/source/config_reference/prebuilt_presets/helpers_url.rst b/docs/source/config_reference/prebuilt_presets/helpers_url.rst new file mode 100644 index 00000000..b6928288 --- /dev/null +++ b/docs/source/config_reference/prebuilt_presets/helpers_url.rst @@ -0,0 +1,7 @@ +==================== +URL Preset Reference +==================== + +.. highlight:: yaml + +.. literalinclude:: /../../src/ytdl_sub/prebuilt_presets/helpers/url.yaml diff --git a/docs/source/config_reference/prebuilt_presets/index.rst b/docs/source/config_reference/prebuilt_presets/index.rst new file mode 100644 index 00000000..9af49b74 --- /dev/null +++ b/docs/source/config_reference/prebuilt_presets/index.rst @@ -0,0 +1,12 @@ +========================= +Prebuilt Preset Reference +========================= + +This section contains the code for the prebuilt presets. If you just want to understand how to use the presets, check :doc:`this section instead`. + + + +.. toctree:: + helpers_common + helpers_players + helpers_url \ No newline at end of file diff --git a/docs/source/prebuilt_presets/tv_shows.rst b/docs/source/prebuilt_presets/tv_shows.rst index ab971a0a..5a26debf 100644 --- a/docs/source/prebuilt_presets/tv_shows.rst +++ b/docs/source/prebuilt_presets/tv_shows.rst @@ -3,7 +3,7 @@ TV Show Presets =============== Player-Specific Presets ------------------------ +======================= ``ytdl-sub`` provides player-specific versions of certain presets, which apply settings to optimize the downloads for that player. @@ -12,15 +12,13 @@ All of these players will have: Jellyfin ~~~~~~~~ -* Places any season-specific poster art in the show folder - +* Places any season-specific poster art in the main show folder +* Generates NFO tags Kodi ~~~~ +* Everything that the Jellyfin version does * Turns on :ref:`config_reference/plugins:kodi_safe`, replacing characters that would break kodi with safer characters -* - - Plex ~~~~ @@ -28,9 +26,8 @@ Plex * Converts all downloaded videos to the mp4 format * Places any season-specific poster art into the season folder - - - +Generic Presets +=============== There are two main methods for downloading and formatting videos as a TV show.