From 89b5ed4a164519a159f05887371469f8ea2a6a91 Mon Sep 17 00:00:00 2001 From: Ana C Date: Fri, 29 Jan 2016 17:49:32 +0100 Subject: 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 (cherry picked from commit f879c91a15dfd0de24367dd098c8c796851f9769) --- docs/apidocs/index.rst | 9 +++++++++ docs/apidocs/modules.rst | 7 +++++++ 2 files changed, 16 insertions(+) create mode 100644 docs/apidocs/index.rst create mode 100644 docs/apidocs/modules.rst (limited to 'docs') 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 -- cgit 1.2.3-korg