From 26b2fea6d21c368bf42c396afbf2e1291135e6d8 Mon Sep 17 00:00:00 2001
From: lethliel <mstrigl@suse.de>
Date: Wed, 29 Apr 2020 20:11:02 +0200
Subject: [PATCH] improve documenation

removed tutorial. Added missing osc.util.helper

added more modules:

* OscConfigParser
* build
* conf
* credentials
---
 docs/api/modules.rst             |  4 ++++
 docs/api/osc.OscConfigParser.rst | 12 ++++++++++++
 docs/api/osc.build.rst           | 12 ++++++++++++
 docs/api/osc.conf.rst            | 13 +++++++++++++
 docs/api/osc.core.rst            |  7 +++++++
 docs/api/osc.credentials.rst     | 12 ++++++++++++
 docs/api/osc.util.rst            |  7 +++----
 docs/index.rst                   |  2 --
 8 files changed, 63 insertions(+), 6 deletions(-)
 create mode 100644 docs/api/osc.OscConfigParser.rst
 create mode 100644 docs/api/osc.build.rst
 create mode 100644 docs/api/osc.conf.rst
 create mode 100644 docs/api/osc.credentials.rst

diff --git a/docs/api/modules.rst b/docs/api/modules.rst
index 26c09852..6ade36c8 100644
--- a/docs/api/modules.rst
+++ b/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
diff --git a/docs/api/osc.OscConfigParser.rst b/docs/api/osc.OscConfigParser.rst
new file mode 100644
index 00000000..3231d8d3
--- /dev/null
+++ b/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:
diff --git a/docs/api/osc.build.rst b/docs/api/osc.build.rst
new file mode 100644
index 00000000..ca80847a
--- /dev/null
+++ b/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:
diff --git a/docs/api/osc.conf.rst b/docs/api/osc.conf.rst
new file mode 100644
index 00000000..f0bd001b
--- /dev/null
+++ b/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:
diff --git a/docs/api/osc.core.rst b/docs/api/osc.core.rst
index b4840baa..0614e870 100644
--- a/docs/api/osc.core.rst
+++ b/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:
+
diff --git a/docs/api/osc.credentials.rst b/docs/api/osc.credentials.rst
new file mode 100644
index 00000000..03218c52
--- /dev/null
+++ b/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:
diff --git a/docs/api/osc.util.rst b/docs/api/osc.util.rst
index e00bd621..2211fb5e 100644
--- a/docs/api/osc.util.rst
+++ b/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:
diff --git a/docs/index.rst b/docs/index.rst
index 2fcde0ae..0dcea62d 100644
--- a/docs/index.rst
+++ b/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`
-