docs/api-docs.rst

   1 ..
   2 ..  Copyright (c) 2019 AT&T Intellectual Property.
   3 ..  Copyright (c) 2019 Nokia.
   4 ..
   5 ..  Licensed under the Creative Commons Attribution 4.0 International
   6 ..  Public License (the "License"); you may not use this file except
   7 ..  in compliance with the License. You may obtain a copy of the License at
   8 ..
   9 ..    https://creativecommons.org/licenses/by/4.0/
  10 ..
  11 ..  Unless required by applicable law or agreed to in writing, documentation
  12 ..  distributed under the License is distributed on an "AS IS" BASIS,
  13 ..  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 ..
  15 ..  See the License for the specific language governing permissions and
  16 ..  limitations under the License.
  17 ..
  18
  19
  20 .. contents::
  21    :depth: 3
  22    :local:
  23
  24 API-docs
  25 ============
  26
  27 .. note
  28
  29 .. This section is used to describe a software API exposed from a O-RAN software component.
  30
  31 .. This note must be removed after content has been added.
  32
  33
  34 API Introduction
  35 ---------------
  36 .. Please add what API a component have exposed.
  37
  38 API Functions
  39 ---------------
  40 .. Please states the API functions.
  41