docs/api-docs.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 ..
   4 .. Copyright (C) 2019 AT&T Intellectual Property
   5
   6
   7 API-Docs
   8 ========
   9
  10 This is the API-docs of <COMPONENT>
  11
  12 .. contents::
  13    :depth: 3
  14    :local:
  15
  16 .. note
  17
  18 .. This section is used to describe a software API exposed from a O-RAN software component.
  19
  20 .. This note must be removed after content has been added.
  21
  22
  23 API Introduction
  24 -----------------
  25 .. Please add what API a component have exposed.
  26
  27 API Functions
  28 -------------
  29 .. Please states the API functions.
  30