Documentation cleanups

Lukeid · Lukeid · Aug 5, 2019 · Feb 9, 2019 · Feb 9, 2019 · Feb 10, 2019
commit 9e3e47c7f82535c43d31d814a8cb02cdbae5b0eb
diff --git a/flexget/plugins/input/betaseries_list.py b/flexget/plugins/input/betaseries_list.py
@@ -18,46 +18,45 @@
 
 class BetaSeriesList(object):
     """
-        Emits an entry for each serie followed by one or more BetaSeries account.
-        See https://www.betaseries.com/
+    Emits an entry for each serie followed by one or more BetaSeries account.
+    See https://www.betaseries.com/
 
-        Configuration examples:
+    Configuration examples:
 
-        # will get all series followed by the account identified by your_user_name
-        betaseries_list:
-          username: your_user_name
-          password: your_password
-          api_key: your_api_key
+    # will get all series followed by the account identified by your_user_name
+    betaseries_list:
+      username: your_user_name
+      password: your_password
+      api_key: your_api_key
 
-        # will get all series followed by the account identified by some_other_guy
-        betaseries_list:
-          username: your_user_name
-          password: your_password
-          api_key: your_api_key
-          members:
-            - some_other_guy
+    # will get all series followed by the account identified by some_other_guy
+    betaseries_list:
+      username: your_user_name
+      password: your_password
+      api_key: your_api_key
+      members:
+        - some_other_guy
 
-        # will get all series followed by the accounts identified by guy1 and guy2
-        betaseries_list:
-          username: your_user_name
-          password: your_password
-          api_key: your_api_key
-          members:
-            - guy1
-            - guy2
+    # will get all series followed by the accounts identified by guy1 and guy2
+    betaseries_list:
+      username: your_user_name
+      password: your_password
+      api_key: your_api_key
+      members:
+        - guy1
+        - guy2
 
 
-        Api key can be requested at https://www.betaseries.com/api.
+    Api key can be requested at https://www.betaseries.com/api.
 
-        This plugin is meant to work with the import_series plugin as follow:
-
-        import_series:
-          from:
-            betaseries_list:
-              username: xxxxx
-              password: xxxxx
-              api_key: xxxxx
+    This plugin is meant to work with the import_series plugin as follow:
 
+    import_series:
+      from:
+        betaseries_list:
+          username: xxxxx
+          password: xxxxx
+          api_key: xxxxx
     """
 
     schema = {

diff --git a/flexget/plugins/input/html.py b/flexget/plugins/input/html.py
@@ -23,15 +23,15 @@
 
 class InputHtml(object):
     """
-        Parses urls from html page. Usefull on sites which have direct download
-        links of any type (mp3, jpg, torrent, ...).
+    Parses urls from html page. Usefull on sites which have direct download
+    links of any type (mp3, jpg, torrent, ...).
 
-        Many anime-fansubbers do not provide RSS-feed, this works well in many cases.
+    Many anime-fansubbers do not provide RSS-feed, this works well in many cases.
 
-        Configuration expects url parameter.
+    Configuration expects url parameter.
 
-        Note: This returns ALL links on url so you need to configure filters
-        to match only to desired content.
+    Note: This returns ALL links on url so you need to configure filters
+    to match only to desired content.
     """
 
     schema = {

diff --git a/flexget/plugins/input/input_csv.py b/flexget/plugins/input/input_csv.py
@@ -17,27 +17,27 @@
 
 class InputCSV(object):
     """
-        Adds support for CSV format. Configuration may seem a bit complex,
-        but this has advantage of being universal solution regardless of CSV
-        and internal entry fields.
+    Adds support for CSV format. Configuration may seem a bit complex,
+    but this has advantage of being universal solution regardless of CSV
+    and internal entry fields.
 
-        Configuration format:
+    Configuration format:
 
-        csv:
-          url: <url>
-          values:
-            <field>: <number>
+    csv:
+      url: <url>
+      values:
+        <field>: <number>
 
-        Example DB-fansubs:
+    Example DB-fansubs:
 
-        csv:
-          url: http://www.dattebayo.com/t/dump
-          values:
-            title: 3  # title is in 3th field
-            url: 1    # download url is in 1st field
+    csv:
+      url: http://www.dattebayo.com/t/dump
+      values:
+        title: 3  # title is in 3th field
+        url: 1    # download url is in 1st field
 
-        Fields title and url are mandatory. First field is 1.
-        List of other common (optional) fields can be found from wiki.
+    Fields title and url are mandatory. First field is 1.
+    List of other common (optional) fields can be found from wiki.
     """
 
     schema = {

diff --git a/flexget/plugins/input/kitsu.py b/flexget/plugins/input/kitsu.py
@@ -14,13 +14,16 @@
 
 
 class KitsuAnime(object):
-    """Creates an entry for each item in your kitsu.io list.
+    """
+    Creates an entry for each item in your kitsu.io list.
+
     Syntax:
+
     kitsu:
       username: <value>
       lists:
-      	- <current|planned|completed|on_hold|dropped>
-      	- <current|planned|completed|on_hold|dropped>
+        - <current|planned|completed|on_hold|dropped>
+        - <current|planned|completed|on_hold|dropped>
       status: <airing|finished>
       latest: <yes|no>
     """

diff --git a/flexget/plugins/input/my_anime_list.py b/flexget/plugins/input/my_anime_list.py
@@ -21,6 +21,7 @@
 
 class MyAnimeList(object):
     """" Creates entries for series and movies from MyAnimeList list
+
     Syntax:
     my_anime_list:
       username: <value>

diff --git a/flexget/plugins/input/npo_watchlist.py b/flexget/plugins/input/npo_watchlist.py
@@ -24,31 +24,31 @@
 
 class NPOWatchlist(object):
     """
-        Produces entries for every episode on the user's npostart.nl watchlist (Dutch public television).
-        Entries can be downloaded using http://arp242.net/code/download-npo
-
-        If 'remove_accepted' is set to 'yes', the plugin will delete accepted entries from the watchlist after download
-            is complete.
-        If 'max_episode_age_days' is set (and not 0), entries will only be generated for episodes broadcast in the last
-            x days.  This only applies to episodes related to series the user is following.
-        If 'download_premium' is set to 'yes', the plugin will also download entries that are marked as exclusive
-            content for NPO Plus subscribers.
-
-        For example:
-            npo_watchlist:
-              email: aaaa@bbb.nl
-              password: xxx
-              remove_accepted: yes
-              max_episode_age_days: 7
-              download_premium: no
-            accept_all: yes
-            exec:
-              fail_entries: yes
-              auto_escape: yes
-              on_output:
-                for_accepted:
-                  - download-npo -o "path/to/directory/{{series_name_plain}}" -f "{serie_titel} - {datum} \
-                      {aflevering_titel} ({episode_id})" -t {{url}}
+    Produces entries for every episode on the user's npostart.nl watchlist (Dutch public television).
+    Entries can be downloaded using http://arp242.net/code/download-npo
+
+    If 'remove_accepted' is set to 'yes', the plugin will delete accepted entries from the watchlist after download
+        is complete.
+    If 'max_episode_age_days' is set (and not 0), entries will only be generated for episodes broadcast in the last
+        x days.  This only applies to episodes related to series the user is following.
+    If 'download_premium' is set to 'yes', the plugin will also download entries that are marked as exclusive
+        content for NPO Plus subscribers.
+
+    For example:
+        npo_watchlist:
+          email: aaaa@bbb.nl
+          password: xxx
+          remove_accepted: yes
+          max_episode_age_days: 7
+          download_premium: no
+        accept_all: yes
+        exec:
+          fail_entries: yes
+          auto_escape: yes
+          on_output:
+            for_accepted:
+              - download-npo -o "path/to/directory/{{series_name_plain}}" -f "{serie_titel} - {datum} \
+                  {aflevering_titel} ({episode_id})" -t {{url}}
         """
 
     schema = {

diff --git a/flexget/plugins/input/rottentomatoes_list.py b/flexget/plugins/input/rottentomatoes_list.py
@@ -19,21 +19,20 @@
 
 class RottenTomatoesList(object):
     """
-        Emits an entry for each movie in a Rotten Tomatoes list.
+    Emits an entry for each movie in a Rotten Tomatoes list.
 
-        Configuration:
+    Configuration:
 
-        dvds:
-          - top_rentals
-          - upcoming
+    dvds:
+      - top_rentals
+      - upcoming
 
-        movies:
-          - box_office
-
-        Possible lists are
-          * dvds: top_rentals, current_releases, new_releases, upcoming
-          * movies: box_office, in_theaters, opening, upcoming
+    movies:
+      - box_office
 
+    Possible lists are
+      * dvds: top_rentals, current_releases, new_releases, upcoming
+      * movies: box_office, in_theaters, opening, upcoming
     """
 
     schema = {

diff --git a/flexget/plugins/input/sickbeard.py b/flexget/plugins/input/sickbeard.py
@@ -14,6 +14,45 @@
 
 
 class Sickbeard(object):
+    """
+    This plugin returns ALL of the shows monitored by Sickbeard.
+    This includes both ongoing and ended.
+    Syntax:
+
+    sickbeard:
+      base_url=<value>
+      port=<value>
+      api_key=<value>
+
+    Options base_url and api_key are required.
+
+    Use with input plugin like discover and/or configure_series.
+    Example:
+
+    download-tv-task:
+      configure_series:
+        settings:
+          quality:
+            - 720p
+        from:
+          sickbeard:
+            base_url: http://localhost
+            port: 8531
+            api_key: MYAPIKEY1123
+      discover:
+        what:
+          - next_series_episodes: yes
+        from:
+          torrentz: any
+      download:
+        /download/tv
+
+    Note that when using the configure_series plugin with Sickbeard
+    you are basically synced to it, so removing a show in Sickbeard will
+    remove it in flexget as well, which could be positive or negative,
+    depending on your usage.
+    """
+
     schema = {
         'type': 'object',
         'properties': {
@@ -48,44 +87,6 @@ def quality_requirement_builder(self, quality_list):
         return [sb_to_fg[quality] for quality in quality_list]
 
     def on_task_input(self, task, config):
-        """
-        This plugin returns ALL of the shows monitored by Sickbeard.
-        This includes both ongoing and ended.
-        Syntax:
-
-        sickbeard:
-          base_url=<value>
-          port=<value>
-          api_key=<value>
-
-        Options base_url and api_key are required.
-
-        Use with input plugin like discover and/or configure_series.
-        Example:
-
-        download-tv-task:
-          configure_series:
-            settings:
-              quality:
-                - 720p
-            from:
-              sickbeard:
-                base_url: http://localhost
-                port: 8531
-                api_key: MYAPIKEY1123
-          discover:
-            what:
-              - next_series_episodes: yes
-            from:
-              torrentz: any
-          download:
-            /download/tv
-
-        Note that when using the configure_series plugin with Sickbeard
-        you are basically synced to it, so removing a show in Sickbeard will
-        remove it in flexget as well, which could be positive or negative,
-        depending on your usage.
-        """
         parsedurl = urlparse(config.get('base_url'))
         url = '%s://%s:%s%s/api/%s/?cmd=shows' % (
             parsedurl.scheme,