summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/write_addons.rst5
-rw-r--r--docs/write_plugins.rst3
2 files changed, 8 insertions, 0 deletions
diff --git a/docs/write_addons.rst b/docs/write_addons.rst
index 9f4436cc5..cc39ab259 100644
--- a/docs/write_addons.rst
+++ b/docs/write_addons.rst
@@ -18,6 +18,7 @@ All addons should start with something like this: ::
from pyload.plugin.Addon import Addon
+
class YourAddon(Addon):
__name = "YourAddon"
__version = "0.1"
@@ -53,6 +54,7 @@ A basic excerpt would look like: ::
from pyload.plugin.Addon import Addon
+
class YourAddon(Addon):
"""
Your Addon code here.
@@ -73,6 +75,7 @@ It requires a `dict` that maps event names to function names or a `list` of func
from pyload.plugin.Addon import Addon
+
class YourAddon(Addon):
"""
Your Addon code here.
@@ -109,6 +112,7 @@ Sounds complicated but is very easy to do. Just use the ``Expose`` decorator: ::
from pyload.plugin.Addon import Addon, Expose
+
class YourAddon(Addon):
"""
Your Addon code here.
@@ -134,6 +138,7 @@ Just store everything in ``self.info``. ::
from pyload.plugin.Addon import Addon
+
class YourAddon(Addon):
"""
Your Addon code here.
diff --git a/docs/write_plugins.rst b/docs/write_plugins.rst
index 64868d638..af35a8d55 100644
--- a/docs/write_plugins.rst
+++ b/docs/write_plugins.rst
@@ -21,6 +21,7 @@ How basic hoster plugin header could look like: ::
from pyload.plugin.Hoster import Hoster
+
class MyFileHoster(Hoster):
__name = "MyFileHoster"
__version = "0.1"
@@ -43,6 +44,7 @@ An example ``process`` function could look like this ::
from pyload.plugin.Hoster import Hoster
+
class MyFileHoster(Hoster):
"""
plugin code
@@ -83,6 +85,7 @@ Example: ::
from pyload.plugin.Crypter import Crypter
+
class MyFileCrypter(Crypter):
"""
plugin code