aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAna C <ana.cunha@ericsson.com>2016-01-29 17:49:32 +0100
committerAna Cunha <ana.cunha@ericsson.com>2016-01-29 17:08:18 +0000
commitf879c91a15dfd0de24367dd098c8c796851f9769 (patch)
treee308d94018340e3db184c519881f21cecd38636f
parent8f6ecefac63f58bc988bc82ecc5247ec98a13d6e (diff)
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>
-rw-r--r--docs/apidocs/index.rst9
-rw-r--r--docs/apidocs/modules.rst7
2 files changed, 16 insertions, 0 deletions
diff --git a/docs/apidocs/index.rst b/docs/apidocs/index.rst
new file mode 100644
index 000000000..594671556
--- /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
index 000000000..271ea147c
--- /dev/null
+++ b/docs/apidocs/modules.rst
@@ -0,0 +1,7 @@
+yardstick
+=========
+
+.. toctree::
+ :maxdepth: 4
+
+ yardstick