Literal include of prebuilt preset files, proof of concept

This commit is contained in:
Qualis Svagtlys 2023-12-22 19:03:16 -06:00
parent e96289eea0
commit e3c4f96074
6 changed files with 44 additions and 13 deletions

View file

@ -1,6 +1,6 @@
================ =========
Config Reference Reference
================ =========
This section contains direct references to the code of ``ytdl-sub`` and information on how it functions. This section contains direct references to the code of ``ytdl-sub`` and information on how it functions.
@ -9,3 +9,4 @@ This section contains direct references to the code of ``ytdl-sub`` and informat
subscriptions_yaml subscriptions_yaml
plugins plugins
scripting/index scripting/index
prebuilt_presets/index

View file

@ -0,0 +1,7 @@
=======================
Common Preset Reference
=======================
.. highlight:: yaml
.. literalinclude:: /../../src/ytdl_sub/prebuilt_presets/helpers/common.yaml

View file

@ -0,0 +1,7 @@
========================
Players Preset Reference
========================
.. highlight:: yaml
.. literalinclude:: /../../src/ytdl_sub/prebuilt_presets/helpers/players.yaml

View file

@ -0,0 +1,7 @@
====================
URL Preset Reference
====================
.. highlight:: yaml
.. literalinclude:: /../../src/ytdl_sub/prebuilt_presets/helpers/url.yaml

View file

@ -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</prebuilt_presets/index>`.
.. toctree::
helpers_common
helpers_players
helpers_url

View file

@ -3,7 +3,7 @@ TV Show Presets
=============== ===============
Player-Specific Presets Player-Specific Presets
----------------------- =======================
``ytdl-sub`` provides player-specific versions of certain presets, which apply settings to optimize the downloads for that player. ``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 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 Kodi
~~~~ ~~~~
* Everything that the Jellyfin version does
* Turns on :ref:`config_reference/plugins:kodi_safe`, replacing characters that would break kodi with safer characters * Turns on :ref:`config_reference/plugins:kodi_safe`, replacing characters that would break kodi with safer characters
*
Plex Plex
~~~~ ~~~~
@ -28,9 +26,8 @@ Plex
* Converts all downloaded videos to the mp4 format * Converts all downloaded videos to the mp4 format
* Places any season-specific poster art into the season folder * 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. There are two main methods for downloading and formatting videos as a TV show.