From 1bb6ebf544b43cacf7c0755c5a8608b79b95e2d6 Mon Sep 17 00:00:00 2001 From: RaNaN Date: Sat, 7 Jan 2012 20:11:16 +0100 Subject: MultiHoster plugin type, some fixes, new documentation structure --- docs/plugins/overview.rst | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100755 docs/plugins/overview.rst (limited to 'docs/plugins/overview.rst') diff --git a/docs/plugins/overview.rst b/docs/plugins/overview.rst new file mode 100755 index 000000000..23913b787 --- /dev/null +++ b/docs/plugins/overview.rst @@ -0,0 +1,31 @@ +.. _overview: + +================ +Extending pyLoad +================ + +.. pull-quote:: + Any sufficiently advanced technology is indistinguishable from magic. + + -- Arthur C. Clarke + + +.. rubric:: Motivation + +pyLoad offers an comfortable and powerful plugin system to make extending possible. With it you only need to have some +python knowledge and can just start right away writing your own plugins. This document gives you an overwiew about the +conceptual part. You should not left out the `Base` part, since it contains basic functionality for all plugins types. + +.. rubric:: Contents + +.. toctree:: + + base_plugin.rst + crypter_plugin.rst + hoster_plugin.rst + account_plugin.rst + hook_plugin.rst + + + +.. rubric:: Footnotes \ No newline at end of file -- cgit v1.2.3 From 180a9ee57a6f4eaa5f4bdd7a272057231f6a5c88 Mon Sep 17 00:00:00 2001 From: RaNaN Date: Sun, 29 Jan 2012 20:09:11 +0100 Subject: doc for base plugin --- docs/plugins/overview.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/plugins/overview.rst') diff --git a/docs/plugins/overview.rst b/docs/plugins/overview.rst index 23913b787..68ad96dfd 100755 --- a/docs/plugins/overview.rst +++ b/docs/plugins/overview.rst @@ -14,7 +14,7 @@ Extending pyLoad pyLoad offers an comfortable and powerful plugin system to make extending possible. With it you only need to have some python knowledge and can just start right away writing your own plugins. This document gives you an overwiew about the -conceptual part. You should not left out the `Base` part, since it contains basic functionality for all plugins types. +conceptual part. You should not left out the :doc:`Base ` part, since it contains basic functionality for all plugins types. .. rubric:: Contents -- cgit v1.2.3 From da4cf026ad116518fefc3429b74a8cd94aeef73f Mon Sep 17 00:00:00 2001 From: RaNaN Date: Sun, 5 Feb 2012 17:27:13 +0100 Subject: updated documentation + diagrams --- docs/plugins/overview.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'docs/plugins/overview.rst') diff --git a/docs/plugins/overview.rst b/docs/plugins/overview.rst index 68ad96dfd..0388db7e2 100755 --- a/docs/plugins/overview.rst +++ b/docs/plugins/overview.rst @@ -15,6 +15,7 @@ Extending pyLoad pyLoad offers an comfortable and powerful plugin system to make extending possible. With it you only need to have some python knowledge and can just start right away writing your own plugins. This document gives you an overwiew about the conceptual part. You should not left out the :doc:`Base ` part, since it contains basic functionality for all plugins types. +A class diagram visualizing the relationship can be find below [1]_ .. rubric:: Contents @@ -28,4 +29,6 @@ conceptual part. You should not left out the :doc:`Base ` part, sin -.. rubric:: Footnotes \ No newline at end of file +.. rubric:: Footnotes + +.. [1] :ref:`plugin_hierarchy` \ No newline at end of file -- cgit v1.2.3 From 4df2b77fdf42046fe19bd371be7c7255986b5980 Mon Sep 17 00:00:00 2001 From: RaNaN Date: Tue, 6 Mar 2012 13:36:39 +0100 Subject: renamed hooks to addons, new filemanager and database, many new api methods you will loose ALL your LINKS, webinterface will NOT work --- docs/plugins/overview.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/plugins/overview.rst') diff --git a/docs/plugins/overview.rst b/docs/plugins/overview.rst index 0388db7e2..70db5ac90 100755 --- a/docs/plugins/overview.rst +++ b/docs/plugins/overview.rst @@ -25,7 +25,7 @@ A class diagram visualizing the relationship can be find below [1]_ crypter_plugin.rst hoster_plugin.rst account_plugin.rst - hook_plugin.rst + addon_plugin.rst -- cgit v1.2.3 From 5a7f415a25d8e036a37851fcd5e9be81caae2804 Mon Sep 17 00:00:00 2001 From: X3n0m0rph59 Date: Sun, 22 Apr 2012 16:54:06 +0200 Subject: Fixed spelling in the documentation --- docs/plugins/overview.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/plugins/overview.rst') diff --git a/docs/plugins/overview.rst b/docs/plugins/overview.rst index 70db5ac90..b3debb053 100755 --- a/docs/plugins/overview.rst +++ b/docs/plugins/overview.rst @@ -12,10 +12,10 @@ Extending pyLoad .. rubric:: Motivation -pyLoad offers an comfortable and powerful plugin system to make extending possible. With it you only need to have some -python knowledge and can just start right away writing your own plugins. This document gives you an overwiew about the -conceptual part. You should not left out the :doc:`Base ` part, since it contains basic functionality for all plugins types. -A class diagram visualizing the relationship can be find below [1]_ +pyLoad offers a comfortable and powerful plugin system to make extensions possible. With it you only need to have some +python knowledge and can just start right away writing your own plugins. This document gives you an overview about the +conceptual part. You should not leave out the :doc:`Base ` part, since it contains basic functionality for all plugin types. +A class diagram visualizing the relationship can be found below [1]_ .. rubric:: Contents -- cgit v1.2.3 From e8eaa91da9e1236d8009df0d79bebe023de8933f Mon Sep 17 00:00:00 2001 From: RaNaN Date: Sun, 6 May 2012 13:04:15 +0200 Subject: little documentation update --- docs/plugins/overview.rst | 1 - 1 file changed, 1 deletion(-) (limited to 'docs/plugins/overview.rst') diff --git a/docs/plugins/overview.rst b/docs/plugins/overview.rst index b3debb053..bbea86756 100755 --- a/docs/plugins/overview.rst +++ b/docs/plugins/overview.rst @@ -28,7 +28,6 @@ A class diagram visualizing the relationship can be found below [1]_ addon_plugin.rst - .. rubric:: Footnotes .. [1] :ref:`plugin_hierarchy` \ No newline at end of file -- cgit v1.2.3