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
   5
   6 API-Docs
   7 ========
   8
   9 This is the API-docs of <COMPONENT>
  10
  11 .. contents::
  12    :depth: 3
  13    :local:
  14
  15 .. note
  16
  17 .. This section is used to describe a software API exposed from a O-RAN software component.
  18
  19 .. This note must be removed after content has been added.
  20
  21
  22 API Introduction
  23 -----------------
  24 .. Please add what API a component have exposed.
  25
  26 API Functions
  27 -------------
  28 .. Please states the API functions.
  29