Add directory for code documentation

This change adds a folder for yardstick code documentation under docs,
apidocs. An index.rst  file is added, and a modules.rst to list the
modules.
The documentation will be automatically generated from code docstrings,
using sphinx autodoc directive.

JIRA:YARDSTICK-161

Change-Id: I56ff1904c319a00352842be5ba7bb0cb52bbc3d6
Signed-off-by: Ana C <ana.cunha@ericsson.com>
(cherry picked from commit f879c91a15dfd0de24367dd098c8c796851f9769)

diff --git a/docs/apidocs/index.rst b/docs/apidocs/index.rst
new file mode 100644 (file)
index 0000000..5946715
--- /dev/null
+++ b/docs/apidocs/index.rst
@@ -0,0 +1,9 @@
+======================================
+Yardstick Framework Code Documentation
+======================================
+
+.. toctree::
+   :numbered:
+   :maxdepth: 3
+
+   modules

diff --git a/docs/apidocs/modules.rst b/docs/apidocs/modules.rst
new file mode 100644 (file)
index 0000000..271ea14
--- /dev/null
+++ b/docs/apidocs/modules.rst
@@ -0,0 +1,7 @@
+yardstick
+=========
+
+.. toctree::
+   :maxdepth: 4
+
+   yardstick