diff options
Diffstat (limited to 'docs/system')
| -rw-r--r-- | docs/system/hoster_diagrams.rst | 16 | ||||
| -rwxr-xr-x | docs/system/overview.rst | 25 | ||||
| -rw-r--r-- | docs/system/plugin_hierarchy.rst | 13 | ||||
| -rw-r--r-- | docs/system/pyload_DataLayout.png | bin | 0 -> 57771 bytes | |||
| -rw-r--r-- | docs/system/pyload_PluginHierarchy.png | bin | 0 -> 22550 bytes | |||
| -rw-r--r-- | docs/system/pyload_ad_Hoster.png | bin | 0 -> 34237 bytes | |||
| -rw-r--r-- | docs/system/pyload_sd_Hoster.png | bin | 0 -> 28501 bytes |
7 files changed, 54 insertions, 0 deletions
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..0e10664c0 --- /dev/null +++ b/docs/system/plugin_hierarchy.rst @@ -0,0 +1,13 @@ +.. _plugin_hierarchy: + +================ +Plugin Hierarchy +================ + +Class diagram that describes plugin relationships. + +.. image:: pyload_PluginHierarchy.png + +Class diagram showing the relationship of api/thrift datatypes. + +.. image:: pyload_DataLayout.png
\ No newline at end of file diff --git a/docs/system/pyload_DataLayout.png b/docs/system/pyload_DataLayout.png Binary files differnew file mode 100644 index 000000000..98ab31a69 --- /dev/null +++ b/docs/system/pyload_DataLayout.png diff --git a/docs/system/pyload_PluginHierarchy.png b/docs/system/pyload_PluginHierarchy.png Binary files differnew file mode 100644 index 000000000..118d3a7a8 --- /dev/null +++ b/docs/system/pyload_PluginHierarchy.png diff --git a/docs/system/pyload_ad_Hoster.png b/docs/system/pyload_ad_Hoster.png Binary files differnew file mode 100644 index 000000000..0ee064edc --- /dev/null +++ b/docs/system/pyload_ad_Hoster.png diff --git a/docs/system/pyload_sd_Hoster.png b/docs/system/pyload_sd_Hoster.png Binary files differnew file mode 100644 index 000000000..e629a1949 --- /dev/null +++ b/docs/system/pyload_sd_Hoster.png |
