[docs] Add API documentation

Since we don't expose any APIs in this release, the patch adds only
stubs that will be filled in in the future.

Change-Id: I2fb955b716e8f0f62fe2374811b1d71c9b230bac
Signed-off-by: Cristina Pauna <cristina.pauna@enea.com>

diff --git a/docs/index.rst b/docs/index.rst
index 1086714..19c9757 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -14,3 +14,4 @@ Integrated Edge Cloud
 
    release/release-notes/index
    release/installation/index
+   release/api/index

diff --git a/docs/release/api/api.rst b/docs/release/api/api.rst
new file mode 100644 (file)
index 0000000..a354824
--- /dev/null
+++ b/docs/release/api/api.rst
@@ -0,0 +1,17 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Akraino Project, Inc. and its contributors
+
+***************
+Akraino IEC API
+***************
+
+
+Introduction
+============
+The purpose of this Document is to enumerate the APIs which are exposed by
+IEC Akraino Blue print project to the external projects Akraino/Non Akraino
+for interaction/integration.
+
+In Akraino Release 1 there aren't any APIs exposed by IEC project, but it is
+expected to have APIs in future releases.

diff --git a/docs/release/api/index.rst b/docs/release/api/index.rst
new file mode 100644 (file)
index 0000000..9162306
--- /dev/null
+++ b/docs/release/api/index.rst
@@ -0,0 +1,11 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Akraino Project, Inc. and its contributors
+
+.. _iec-api:
+
+.. toctree::
+   :maxdepth: 2
+
+   api.rst
+