Merge pull request #788 from lethliel/documentation

improve documenation

docs/api/modules.rst

@@ -8,3 +8,7 @@ These are the packages in the osc package.
 
    osc.core
    osc.util
+   osc.credentials
+   osc.build
+   osc.conf
+   osc.OscConfigParser

docs/api/osc.OscConfigParser.rst

@@ -0,0 +1,12 @@
+.. py:module:: osc.OscConfigParser
+
+OscConfigParser
+====
+
+This is the osc config parser.
+
+basic structures
+----------------
+
+.. automodule:: osc.OscConfigParser
+   :members:

docs/api/osc.build.rst

@@ -0,0 +1,12 @@
+.. py:module:: osc.build
+
+build
+====
+
+This is the osc build module to talk to the build script.
+
+basic structures
+----------------
+
+.. automodule:: osc.build
+   :members:

docs/api/osc.conf.rst

@@ -0,0 +1,13 @@
+.. py:module:: osc.conf
+
+conf
+====
+
+This is the osc conf module.
+It handles the configuration of osc
+
+basic structures
+----------------
+
+.. automodule:: osc.conf
+   :members:

docs/api/osc.core.rst

@@ -8,6 +8,9 @@ This is the osc core module.
 basic structures
 ----------------
 
+.. automodule:: osc.core
+   :members:
+
 .. autoclass:: File
     :members:
 
@@ -18,3 +21,7 @@ basic structures
 
 .. autoclass:: Linkinfo
     :members:
+
+.. autoclass:: Project
+    :members:
+

docs/api/osc.credentials.rst

@@ -0,0 +1,12 @@
+.. py:module:: osc.credentials
+
+credentials
+====
+
+This is the osc credentials module.
+
+basic structures
+----------------
+
+.. automodule:: osc.credentials
+   :members:

docs/api/osc.util.rst

@@ -68,11 +68,10 @@ osc.util.safewriter module
     :undoc-members:
     :show-inheritance:
 
+osc.util.helper module
+--------------------------
 
-Module contents
----------------
-
-.. automodule:: osc.util
+.. automodule:: osc.util.helper
     :members:
     :undoc-members:
     :show-inheritance:

docs/index.rst

@@ -19,7 +19,6 @@ API:
 .. toctree::
    :maxdepth: 2
 
-   api/tutorial
    api/modules
 
 
@@ -30,4 +29,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-