diff --git a/README.md b/README.md index f2ba4fd5..15036dff 100644 --- a/README.md +++ b/README.md @@ -182,7 +182,7 @@ music_videos/ ## Custom Configs Any part of this process is modifiable by using custom configs. See our -[walk-through guide](https://github.com/jmbannon/ytdl-sub/wiki) +[walk-through guide](https://ytdl-sub.readthedocs.io/en/latest/guides/index.html) on how to build your first config from scratch. Ready-to-use [example configurations](https://github.com/jmbannon/ytdl-sub/tree/master/examples) can be found here alongside our diff --git a/docker/root/defaults/config.yaml b/docker/root/defaults/config.yaml index 6906f357..9a55063e 100644 --- a/docker/root/defaults/config.yaml +++ b/docker/root/defaults/config.yaml @@ -1,8 +1,8 @@ # Bare-bones config. Here are some useful links to get started: -# Walk-through Guide: https://github.com/jmbannon/ytdl-sub/wiki/1.-Introduction +# Walk-through Guide: https://ytdl-sub.readthedocs.io/en/latest/guides/index.html # Config Examples: https://github.com/jmbannon/ytdl-sub/tree/master/examples # Prebuilt Presets: https://ytdl-sub.readthedocs.io/en/latest/presets.html -# Config Docs: https://ytdl-sub.readthedocs.io/en/latest/config.html +# Config Reference: https://ytdl-sub.readthedocs.io/en/latest/config_reference/index.html # # The subscriptions in `subscriptions.yaml` uses prebuilt presets which do not require # any additions to this config. They can be downloaded using the command: diff --git a/docs/source/conf.py b/docs/source/conf.py index 7e551b67..f754815a 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -7,9 +7,9 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = "ytdl-sub" -copyright = "2023, Jesse Bannon" +copyright = "2024, Jesse Bannon" author = "Jesse Bannon" -release = "2023.12.15" +release = "" # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration @@ -47,7 +47,7 @@ html_theme_options = { "type": "url", }, ], - "announcement": ("Please excuse our mess as we update these documents"), + "announcement": "", "navigation_depth": 10, "show_toc_level": 10, } diff --git a/docs/source/config_reference/plugins.rst b/docs/source/config_reference/plugins.rst index 6aa05162..7e9d1688 100644 --- a/docs/source/config_reference/plugins.rst +++ b/docs/source/config_reference/plugins.rst @@ -156,7 +156,7 @@ granularity possible. :expected type: Optional[OverridesFormatter] :description: - Only download videos before this datetime. + Only download videos after this datetime. ``before`` diff --git a/docs/source/faq/index.rst b/docs/source/faq/index.rst index 489240de..b55f155c 100644 --- a/docs/source/faq/index.rst +++ b/docs/source/faq/index.rst @@ -10,6 +10,18 @@ Since ytdl-sub is relatively new to the public, there has not been many question How do I... ----------- +...remove the date in the video title? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The :ref:`config_reference/prebuilt_presets/tv_show:TV Show` presets by default include the upload date in the ``episode_title`` +override variable. This variable is used to set the title in things like the video metadata, NFO file, etc, which is +subsequently read by media players. This can be overwritten as you see fit by redefining it: + +.. code-block:: yaml + + overrides: + episode_title: "{title}" # Only sets the video title + ...get support or reach out to contribute? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/source/guides/getting_started/index.rst b/docs/source/guides/getting_started/index.rst index c503a5ad..3aa856bc 100644 --- a/docs/source/guides/getting_started/index.rst +++ b/docs/source/guides/getting_started/index.rst @@ -29,28 +29,44 @@ If you plan on using the headless image of ``ytdl-sub``, you: Additional useful (but not required) knowledge: ☑ Understanding how :yt-dlp:`\ ` works - -Quick Overview of ``ytdl-sub`` ------------------------------- - +Overview +-------- ``ytdl-sub`` uses two types of YAML files: -- ``config.yaml`` defines ``presets``, which are the "definitions" of your media. ``presets`` "define" how you want your media downloaded, which formats, naming conventions to follow when saving them, etc. These ``presets`` can also inherit other ``presets``, so that you can easily modify an existing ``preset``. -- ``subscriptions.yaml`` defines ``subscriptions``, which specify the media we want to recurrently download, like YouTube channels and playlists, SoundCloud artists, or any :yt-dlp:`yt-dlp supported site `. ``subscriptions`` use ``presets`` to define how ``ytdl-sub`` should handle downloading, processing, and saving them. +subscriptions.yaml +~~~~~~~~~~~~~~~~~~ +Defines ``subscriptions``, which specify the media we want to recurrently download, like YouTube +channels and playlists, SoundCloud artists, or any +:yt-dlp:`yt-dlp supported site `. ``subscriptions`` use ``presets`` +to define how ``ytdl-sub`` should handle downloading, processing, and saving them. -When ``ytdl-sub`` is run, in its most basic form: +``ytdl-sub`` comes packaged with many +:ref:`prebuilt presets ` +that will play nicely with well-known media players. + +config.yaml +~~~~~~~~~~~ +To customize ``ytdl-sub`` to beyond the prebuilt presets, you will need a ``config.yaml`` file. This +file is where custom ``presets`` can be defined to orchestrate ``ytdl-sub`` to your very specific needs. + +Running ytdl-sub +~~~~~~~~~~~~~~~~ +To invoke ``ytdl-sub`` to download subscriptions, use the following command: .. tab-set-code:: .. code-block:: shell - ytdl-sub sub + ytdl-sub sub subscriptions.yaml .. code-block:: powershell - ytdl-sub.exe sub + ytdl-sub.exe sub subscriptions.yaml -``ytdl-sub`` initially downloads all files to a defined ``working_directory``. This is a temporary storage spot for metadata and media files so that errors during processing- if they occur- don't affect your existing media library. Once all file processing is complete, your media files are moved to the ``output_directory``. +``ytdl-sub`` initially downloads all files to a defined ``working_directory``. This is a temporary +storage spot for metadata and media files so that errors during processing- if they occur- don't +affect your existing media library. Once all file processing is complete, your media files are +moved to the ``output_directory``. Ready to Start? --------------- diff --git a/docs/source/prebuilt_presets/tv_shows.rst b/docs/source/prebuilt_presets/tv_shows.rst index f2b1da1d..a7770d0f 100644 --- a/docs/source/prebuilt_presets/tv_shows.rst +++ b/docs/source/prebuilt_presets/tv_shows.rst @@ -11,17 +11,17 @@ The following actions are taken based on the indicated player: Jellyfin -~~~~~~~~ +-------- * Places any season-specific poster art in the main show folder * Generates NFO tags Kodi -~~~~ +-------- * Everything that the Jellyfin version does * Enables ``kodi_safe`` NFOs, replacing 4-byte unicode characters that break kodi with ``□`` Plex -~~~~ +-------- * :ref:`Special sanitization ` of numbers so Plex doesn't recognize numbers that are part of the title as the episode number * Converts all downloaded videos to the mp4 format * Places any season-specific poster art into the season folder diff --git a/src/ytdl_sub/plugins/date_range.py b/src/ytdl_sub/plugins/date_range.py index e01ce1ff..27b9c808 100644 --- a/src/ytdl_sub/plugins/date_range.py +++ b/src/ytdl_sub/plugins/date_range.py @@ -57,7 +57,7 @@ class DateRangeOptions(ToggleableOptionsDictValidator): """ :expected type: Optional[OverridesFormatter] :description: - Only download videos before this datetime. + Only download videos after this datetime. """ return self._after