summaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorGravatar RaNaN <Mast3rRaNaN@hotmail.de> 2011-07-01 17:48:52 +0200
committerGravatar RaNaN <Mast3rRaNaN@hotmail.de> 2011-07-01 17:48:52 +0200
commitc0d3b2d6dd9f34dcf53db7047defdcc2c214eb79 (patch)
tree44a552faaa4d119e1a547a1e74fef54e853a110e /docs/index.rst
parentnew api class + documentation (diff)
downloadpyload-c0d3b2d6dd9f34dcf53db7047defdcc2c214eb79.tar.xz
sphinx documentation
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 000000000..ce49325e7
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,29 @@
+.. pyLoad documentation master file, created by
+ sphinx-quickstart on Sat Jun 4 11:54:34 2011.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to pyLoad's documentation!
+==================================
+
+Great that you found your way to the pyLoad documentation!
+
+We have collected some information here to help developer writing plugins and understandig our code.
+If you want to help us developing visit us in our IRC channel #pyload on freenode.net or leave a message in our forum.
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ access_api.rst
+ write_plugins.rst
+ module_overview.rst
+
+.. currentmodule:: module
+
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`