From 945dc12b15639b8116181652ece9f7a21d50a34c Mon Sep 17 00:00:00 2001 From: Cristina Pauna Date: Tue, 7 May 2019 15:57:57 +0300 Subject: [PATCH] [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 --- docs/index.rst | 1 + docs/release/api/api.rst | 17 +++++++++++++++++ docs/release/api/index.rst | 11 +++++++++++ 3 files changed, 29 insertions(+) create mode 100644 docs/release/api/api.rst create mode 100644 docs/release/api/index.rst diff --git a/docs/index.rst b/docs/index.rst index 1086714..19c9757 100644 --- 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 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 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 + -- 2.16.6