Extend class/method docs and publish as user guide

[ric-plt/xapp-frame-py.git] / docs / user-guide.rst

diff --git a/docs/user-guide.rst b/docs/user-guide.rst
new file mode 100644 (file)
index 0000000..7147f02
--- /dev/null
+++ b/docs/user-guide.rst
@@ -0,0 +1,40 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) 2020 AT&T Intellectual Property
+
+User Guide
+==========
+
+This document explains how to develop an Xapp using the RIC Xapp framework.
+Information for maintainers of this framework is in the Developer Guide.
+
+Xapp writers should use the public classes and methods from the Xapp Python
+framework package as documented below.
+
+
+Class RMRXapp
+-------------
+
+Application writers should extend this class to implement a reactive Xapp;
+also see class Xapp.
+
+.. autoclass:: ricxappframe.xapp_frame.RMRXapp
+    :members:
+
+Class Xapp
+----------
+
+Application writers should extend this class to implement a general Xapp;
+also see class RMRXapp.
+
+.. autoclass:: ricxappframe.xapp_frame.Xapp
+    :members:
+
+
+Class SDLWrapper
+----------------
+
+Application writers may instantiate this class directly to communicate with the SDL service.
+
+.. autoclass:: ricxappframe.xapp_sdl.SDLWrapper
+    :members: