From e26a1a6ffc4a640bd2c9e9684d830f5d4521725a Mon Sep 17 00:00:00 2001
From: Irina Gulina <igulina@redhat.com>
Date: Jun 21 2017 11:53:41 +0000
Subject: docs building up api menu in main menu


---

diff --git a/docs/api/bashhelper.rst b/docs/api/bashhelper.rst
new file mode 100644
index 0000000..4658009
--- /dev/null
+++ b/docs/api/bashhelper.rst
@@ -0,0 +1,6 @@
+BASH Helper
+===========
+
+.. automodule:: moduleframework.bashhelper
+   :members:
+   :undoc-members:
diff --git a/docs/api/compose_info.rst b/docs/api/compose_info.rst
new file mode 100644
index 0000000..43441e0
--- /dev/null
+++ b/docs/api/compose_info.rst
@@ -0,0 +1,6 @@
+Module for reading data from compose
+====================================
+
+.. automodule:: moduleframework.compose_info
+   :members:
+   :undoc-members:
diff --git a/docs/api/dockerlinter.rst b/docs/api/dockerlinter.rst
new file mode 100644
index 0000000..16545ec
--- /dev/null
+++ b/docs/api/dockerlinter.rst
@@ -0,0 +1,6 @@
+Docker
+======
+
+.. automodule:: moduleframework.dockerlinter
+   :members:
+   :undoc-members:
diff --git a/docs/api/exceptions_debug.rst b/docs/api/exceptions_debug.rst
new file mode 100644
index 0000000..3fcae97
--- /dev/null
+++ b/docs/api/exceptions_debug.rst
@@ -0,0 +1,7 @@
+Exceptions and Debug
+====================
+
+.. automodule:: moduleframework.common
+   :members:
+   :undoc-members:
+
diff --git a/docs/api/generator.rst b/docs/api/generator.rst
new file mode 100644
index 0000000..1e5e1f2
--- /dev/null
+++ b/docs/api/generator.rst
@@ -0,0 +1,6 @@
+MTF Generator
+=============
+
+.. automodule:: moduleframework.generator
+   :members:
+   :undoc-members:
diff --git a/docs/api/index.rst b/docs/api/index.rst
new file mode 100644
index 0000000..f795c6b
--- /dev/null
+++ b/docs/api/index.rst
@@ -0,0 +1,25 @@
+API Index
+=========
+
+This section contains the MTF API, auto generated from `the source code`_.
+
+.. _the source code: https://pagure.io/modularity-testing-framework
+
+.. toctree::
+
+   module_framework
+   exceptions_debug
+   generator
+   compose_info
+   pdc_data
+   dockerlinter
+   bashhelper
+   timeoutlib
+   version
+
+.. seealso::
+
+   :doc:`../user_guide/index`
+       User Guide
+   `webchat.freenode.net  <https://webchat.freenode.net/?channels=fedora-modularity>`_
+       Questions? Help? Ideas? Stop by the #fedora-modularity chat channel on freenode IRC.
diff --git a/docs/api/module_framework.rst b/docs/api/module_framework.rst
new file mode 100644
index 0000000..d2e7bda
--- /dev/null
+++ b/docs/api/module_framework.rst
@@ -0,0 +1,6 @@
+Module Framework
+================
+
+.. automodule:: moduleframework.module_framework
+   :members:
+   :undoc-members:
diff --git a/docs/api/pdc_data.rst b/docs/api/pdc_data.rst
new file mode 100644
index 0000000..f0c4123
--- /dev/null
+++ b/docs/api/pdc_data.rst
@@ -0,0 +1,6 @@
+PDC data
+========
+
+.. automodule:: moduleframework.pdc_data
+   :members:
+   :undoc-members:
diff --git a/docs/api/timeoutlib.rst b/docs/api/timeoutlib.rst
new file mode 100644
index 0000000..97aa062
--- /dev/null
+++ b/docs/api/timeoutlib.rst
@@ -0,0 +1,6 @@
+Timeoutlib
+==========
+
+.. automodule:: moduleframework.timeoutlib
+   :members:
+   :undoc-members:
diff --git a/docs/api/version.rst b/docs/api/version.rst
new file mode 100644
index 0000000..0798424
--- /dev/null
+++ b/docs/api/version.rst
@@ -0,0 +1,6 @@
+Version
+=======
+
+.. automodule:: moduleframework.version
+   :members:
+   :undoc-members:
diff --git a/docs/bashhelper.rst b/docs/bashhelper.rst
deleted file mode 100644
index f7d27ea..0000000
--- a/docs/bashhelper.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-BASH Helper module
-==================
-
-.. automodule:: moduleframework.bashhelper
-   :members:
-   :undoc-members:
diff --git a/docs/clsoverview.rst b/docs/clsoverview.rst
deleted file mode 100644
index fbe8654..0000000
--- a/docs/clsoverview.rst
+++ /dev/null
@@ -1,11 +0,0 @@
-Module overview
-===============
-
-.. toctree::
-   :maxdepth: 2
-
-   bashhelper
-   compose_info
-   generator
-   module_framework
-   pdc_data
diff --git a/docs/compose_info.rst b/docs/compose_info.rst
deleted file mode 100644
index 43441e0..0000000
--- a/docs/compose_info.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-Module for reading data from compose
-====================================
-
-.. automodule:: moduleframework.compose_info
-   :members:
-   :undoc-members:
diff --git a/docs/generator.rst b/docs/generator.rst
deleted file mode 100644
index 731660d..0000000
--- a/docs/generator.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-Generator module
-================
-
-.. automodule:: moduleframework.generator
-   :members:
-   :undoc-members:
diff --git a/docs/index.rst b/docs/index.rst
index 72339e8..4ff2ad4 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -37,6 +37,7 @@ Content
 
    installation
    user_guide/index
+   api/index
    license
 
 Index and Search
diff --git a/docs/module_framework.rst b/docs/module_framework.rst
deleted file mode 100644
index a424fbb..0000000
--- a/docs/module_framework.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-Main Module Framework module
-============================
-
-.. automodule:: moduleframework.module_framework
-   :members:
-   :undoc-members:
diff --git a/docs/pdc_data.rst b/docs/pdc_data.rst
deleted file mode 100644
index d24c7e7..0000000
--- a/docs/pdc_data.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-Module for PDC
-==============
-
-.. automodule:: moduleframework.pdc_data
-   :members:
-   :undoc-members:
diff --git a/docs/user_guide/index.rst b/docs/user_guide/index.rst
index 478788d..5ac4e31 100644
--- a/docs/user_guide/index.rst
+++ b/docs/user_guide/index.rst
@@ -11,11 +11,12 @@ User Guide
 
 3. Check the list of `Environment variables`_.
 
-.. _Environment variables: environment_variables.
+.. _Environment variables: environment_variables
 
-4. Write your tests, for example see `sanity tests`_ and various tests examples in ``/usr/share/moduleframework/examples/testing-module/``. All tests methods are listed in section :ref:`genindex`.
+4. Write your tests, for example see `sanity tests`_ and various tests examples in ``/usr/share/moduleframework/examples/testing-module/``. All tests methods are listed in section `API Index`_ and alphabetically in :ref:`genindex` section.
 
 .. _sanity tests: https://pagure.io/modularity-testing-framework/blob/master/f/examples/template/sanity_template.py
+.. _API Index: ../api/index
 
 5. In the directory ``tests`` create a ``Makefile`` as below. Mind to keep the ``generator`` line only if there are multiline Bash snippet tests in the ``tests/config.yaml`` file.
 
@@ -89,5 +90,7 @@ Contents:
 
 .. seealso::
 
+   :doc:`../api/index`
+       API Index
    `webchat.freenode.net  <https://webchat.freenode.net/?channels=fedora-modularity>`_
        Questions? Help? Ideas? Stop by the #fedora-modularity chat channel on freenode IRC.
diff --git a/moduleframework/common.py b/moduleframework/common.py
index 13d71a4..ecfc00b 100644
--- a/moduleframework/common.py
+++ b/moduleframework/common.py
@@ -22,8 +22,6 @@
 #
 
 """
-MODULARITY TESTING FRAMEWORK - common
-----------------------------
 It provides some general functions
 """
 
diff --git a/moduleframework/module_framework.py b/moduleframework/module_framework.py
index f54406f..63e5e89 100755
--- a/moduleframework/module_framework.py
+++ b/moduleframework/module_framework.py
@@ -22,8 +22,6 @@
 #
 
 """
-MODULARITY TESTING FRAMEWORK
-----------------------------
 main module provides helpers for various module types and AVOCADO(unittest) classes
 what you should use for your tests (inherited)
 """

