Skip to content

Commit

Permalink
Add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Kamaroth92 committed Jan 9, 2025
1 parent 52a1be3 commit 9a389d8
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 2 deletions.
73 changes: 73 additions & 0 deletions docs/source/config_reference/plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -615,6 +615,79 @@ Usage:
<genre>Comedy</genre>
<genre>Drama</genre>
----------------------------------------------------------------------------------------------------

season_nfo_tags
-------------------------
Adds a single NFO file in the season directory. An NFO file is simply an XML file with a
``.nfo`` extension. It uses the last entry's source variables which can change per download
invocation. Be cautious of which variables you use.

Usage:

.. code-block:: yaml
presets:
my_example_preset:
season_nfo_tags:
# required
nfo_name: "Season 01/season.nfo"
nfo_root: "season"
tags:
title: "My custom season name!"
# optional
kodi_safe: False
``enable``

:expected type: Optional[OverridesFormatter]
:description:
Can typically be left undefined to always default to enable. For preset convenience,
this field can be set using an override variable to easily toggle whether this plugin
is enabled or not via Boolean.


``kodi_safe``

:expected type: Optional[Boolean]
:description:
Defaults to False. Kodi does not support > 3-byte unicode characters, which include
emojis and some foreign language characters. Setting this to True will replace those
characters with '□'.


``nfo_name``

:expected type: EntryFormatter
:description:
The NFO file name.


``nfo_root``

:expected type: EntryFormatter
:description:
The root tag of the NFO's XML. In the usage above, it would look like

.. code-block:: xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<season>
</season>
``tags``

:expected type: NfoTags
:description:
Tags within the nfo_root tag. In the usage above, it would look like

.. code-block:: xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<season>
<title>My custom season name!</title>
</season>
----------------------------------------------------------------------------------------------------

Expand Down
4 changes: 2 additions & 2 deletions src/ytdl_sub/__init__.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
__pypi_version__ = "2025.01.09"
__local_version__ = "2025.01.09+57c5d3c"
__pypi_version__ = "2025.01.09.post1"
__local_version__ = "2025.01.09+52a1be3"

0 comments on commit 9a389d8

Please sign in to comment.