From 645d72cba67de88af1a5a37c685e3496fba507e9 Mon Sep 17 00:00:00 2001 From: Jesse Bannon Date: Sat, 17 Feb 2024 08:17:20 -0800 Subject: [PATCH] [DOCS] Various doc cleanups --- docs/source/conf.py | 6 +++--- docs/source/config_reference/plugins.rst | 2 +- docs/source/faq/index.rst | 12 ++++++++++++ docs/source/prebuilt_presets/tv_shows.rst | 6 +++--- src/ytdl_sub/plugins/date_range.py | 2 +- 5 files changed, 20 insertions(+), 8 deletions(-) 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/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