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/system/hoster_diagrams.rst | 16 ++++++++++++++++ docs/system/overview.rst | 25 +++++++++++++++++++++++++ docs/system/plugin_hierarchy.rst | 9 +++++++++ docs/system/pyload_PluginHierarchy.png | Bin 0 -> 23553 bytes docs/system/pyload_ad_Hoster.png | Bin 0 -> 34237 bytes docs/system/pyload_sd_Hoster.png | Bin 0 -> 28501 bytes 6 files changed, 50 insertions(+) create mode 100644 docs/system/hoster_diagrams.rst create mode 100755 docs/system/overview.rst create mode 100644 docs/system/plugin_hierarchy.rst create mode 100644 docs/system/pyload_PluginHierarchy.png create mode 100644 docs/system/pyload_ad_Hoster.png create mode 100644 docs/system/pyload_sd_Hoster.png (limited to 'docs/system') diff --git a/docs/system/hoster_diagrams.rst b/docs/system/hoster_diagrams.rst new file mode 100644 index 000000000..313f75c57 --- /dev/null +++ b/docs/system/hoster_diagrams.rst @@ -0,0 +1,16 @@ +.. _hoster_diagrams: + +=============== +Hoster Workflow +=============== + +The basic workflow of a hoster plugin. This is only a generalization, in most cases it is more complex +and order will differ. + +Activity Diagram +---------------- +.. image:: pyload_ad_Hoster.png + +Sequence Diagram +---------------- +.. image:: pyload_sd_Hoster.png \ No newline at end of file diff --git a/docs/system/overview.rst b/docs/system/overview.rst new file mode 100755 index 000000000..00e439f45 --- /dev/null +++ b/docs/system/overview.rst @@ -0,0 +1,25 @@ +.. _overview: + +============= +System Design +============= + +.. pull-quote:: + Programs must be written for people to read, and only incidentally for machines to execute. + + -- H. Abelson and G. Sussman + + +.. rubric:: Motivation + +In this section you will find information and diagrams to better understand the concept of pyload. + +.. rubric:: Contents + +.. toctree:: + + plugin_hierarchy.rst + hoster_diagrams.rst + + +.. rubric:: Footnotes \ No newline at end of file diff --git a/docs/system/plugin_hierarchy.rst b/docs/system/plugin_hierarchy.rst new file mode 100644 index 000000000..b663943a3 --- /dev/null +++ b/docs/system/plugin_hierarchy.rst @@ -0,0 +1,9 @@ +.. _plugin_hierarchy: + +================ +Plugin Hierarchy +================ + +Class diagram that describes plugin relationships. + +.. image:: pyload_PluginHierarchy.png \ No newline at end of file diff --git a/docs/system/pyload_PluginHierarchy.png b/docs/system/pyload_PluginHierarchy.png new file mode 100644 index 000000000..f1a753ee2 Binary files /dev/null and b/docs/system/pyload_PluginHierarchy.png differ diff --git a/docs/system/pyload_ad_Hoster.png b/docs/system/pyload_ad_Hoster.png new file mode 100644 index 000000000..0ee064edc Binary files /dev/null and b/docs/system/pyload_ad_Hoster.png differ diff --git a/docs/system/pyload_sd_Hoster.png b/docs/system/pyload_sd_Hoster.png new file mode 100644 index 000000000..e629a1949 Binary files /dev/null and b/docs/system/pyload_sd_Hoster.png differ -- cgit v1.2.3