From 47a4f2ca7005d4c2df818a47613a62d70a634eae Mon Sep 17 00:00:00 2001
From: Tane Barriball <tanebarriball@gmail.com>
Date: Thu, 9 Jan 2025 15:06:10 +1100
Subject: [PATCH] Add docs

---
 docs/source/config_reference/plugins.rst | 148 ++++++++++++-----------
 src/ytdl_sub/__init__.py                 |   4 +-
 2 files changed, 77 insertions(+), 75 deletions(-)

diff --git a/docs/source/config_reference/plugins.rst b/docs/source/config_reference/plugins.rst
index 86f69a12..572270ff 100644
--- a/docs/source/config_reference/plugins.rst
+++ b/docs/source/config_reference/plugins.rst
@@ -615,79 +615,6 @@ 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>
 
 ----------------------------------------------------------------------------------------------------
 
@@ -843,6 +770,81 @@ In addition, any override variable defined will automatically create a ``sanitiz
 for use. In the example above, ``output_directory_sanitized`` will exist and perform
 sanitization on the value when used.
 
+----------------------------------------------------------------------------------------------------
+
+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.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>
+
+
 ----------------------------------------------------------------------------------------------------
 
 split_by_chapters
diff --git a/src/ytdl_sub/__init__.py b/src/ytdl_sub/__init__.py
index d319f563..8102f076 100644
--- a/src/ytdl_sub/__init__.py
+++ b/src/ytdl_sub/__init__.py
@@ -1,2 +1,2 @@
-__pypi_version__ = "2025.01.09.post1"
-__local_version__ = "2025.01.09+52a1be3"
+__pypi_version__ = "2025.01.09.post2"
+__local_version__ = "2025.01.09+9a389d8"