docs/templates/sections/offeredapis.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 Offered APIs
   5 ============
   6
   7 .. note::
   8    * This section is used to describe the external interfaces offered by a software component
   9
  10    * This section is typically: provided for a  platform-component and sdk; and
  11      referenced in developer guides and api reference manuals.
  12
  13    * This note must be removed after content has been added.
  14
  15
  16
  17 Here are several examples:
  18
  19 .. toctree::
  20    :maxdepth: 1
  21    :titlesonly:
  22
  23    apiexample/swaggerv2doc.rst
  24    apiexample/swagger2markup.rst
  25    apiexample/worddoc2rst.rst
  26    apiexample/httpdomain.rst