[DOCS] Various doc cleanups
This commit is contained in:
parent
7c217db843
commit
645d72cba6
5 changed files with 20 additions and 8 deletions
|
|
@ -7,9 +7,9 @@
|
||||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
||||||
|
|
||||||
project = "ytdl-sub"
|
project = "ytdl-sub"
|
||||||
copyright = "2023, Jesse Bannon"
|
copyright = "2024, Jesse Bannon"
|
||||||
author = "Jesse Bannon"
|
author = "Jesse Bannon"
|
||||||
release = "2023.12.15"
|
release = ""
|
||||||
|
|
||||||
# -- General configuration ---------------------------------------------------
|
# -- General configuration ---------------------------------------------------
|
||||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||||||
|
|
@ -47,7 +47,7 @@ html_theme_options = {
|
||||||
"type": "url",
|
"type": "url",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
"announcement": ("Please excuse our mess as we update these documents"),
|
"announcement": "",
|
||||||
"navigation_depth": 10,
|
"navigation_depth": 10,
|
||||||
"show_toc_level": 10,
|
"show_toc_level": 10,
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -156,7 +156,7 @@ granularity possible.
|
||||||
|
|
||||||
:expected type: Optional[OverridesFormatter]
|
:expected type: Optional[OverridesFormatter]
|
||||||
:description:
|
:description:
|
||||||
Only download videos before this datetime.
|
Only download videos after this datetime.
|
||||||
|
|
||||||
|
|
||||||
``before``
|
``before``
|
||||||
|
|
|
||||||
|
|
@ -10,6 +10,18 @@ Since ytdl-sub is relatively new to the public, there has not been many question
|
||||||
How do I...
|
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?
|
...get support or reach out to contribute?
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -11,17 +11,17 @@ The following actions are taken based on the indicated player:
|
||||||
|
|
||||||
|
|
||||||
Jellyfin
|
Jellyfin
|
||||||
~~~~~~~~
|
--------
|
||||||
* Places any season-specific poster art in the main show folder
|
* Places any season-specific poster art in the main show folder
|
||||||
* Generates NFO tags
|
* Generates NFO tags
|
||||||
|
|
||||||
Kodi
|
Kodi
|
||||||
~~~~
|
--------
|
||||||
* Everything that the Jellyfin version does
|
* Everything that the Jellyfin version does
|
||||||
* Enables ``kodi_safe`` NFOs, replacing 4-byte unicode characters that break kodi with ``□``
|
* Enables ``kodi_safe`` NFOs, replacing 4-byte unicode characters that break kodi with ``□``
|
||||||
|
|
||||||
Plex
|
Plex
|
||||||
~~~~
|
--------
|
||||||
* :ref:`Special sanitization <config_reference/scripting/entry_variables:title_sanitized_plex>` of numbers so Plex doesn't recognize numbers that are part of the title as the episode number
|
* :ref:`Special sanitization <config_reference/scripting/entry_variables:title_sanitized_plex>` 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
|
* 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
|
||||||
|
|
|
||||||
|
|
@ -57,7 +57,7 @@ class DateRangeOptions(ToggleableOptionsDictValidator):
|
||||||
"""
|
"""
|
||||||
:expected type: Optional[OverridesFormatter]
|
:expected type: Optional[OverridesFormatter]
|
||||||
:description:
|
:description:
|
||||||
Only download videos before this datetime.
|
Only download videos after this datetime.
|
||||||
"""
|
"""
|
||||||
return self._after
|
return self._after
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue