From 1847e627ee6b2e94892721f0af4fa0af4d0e785f Mon Sep 17 00:00:00 2001 From: Tal Gitelman Date: Wed, 11 Oct 2017 11:31:26 +0300 Subject: Setup Read The Docs for SDC Change-Id: I5bf67b7bb881cebf2ba8fedf1ab69a12889453e2 Issue-ID: SDC-419 Signed-off-by: Tal Gitelman --- ...cs-templates-platform-component-offeredapis.rst | 29 ++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 docs/onap-developer/docs-templates-platform-component-offeredapis.rst (limited to 'docs/onap-developer/docs-templates-platform-component-offeredapis.rst') diff --git a/docs/onap-developer/docs-templates-platform-component-offeredapis.rst b/docs/onap-developer/docs-templates-platform-component-offeredapis.rst new file mode 100644 index 0000000000..55e58bd9b3 --- /dev/null +++ b/docs/onap-developer/docs-templates-platform-component-offeredapis.rst @@ -0,0 +1,29 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +Offered APIs +============ +List APIs offered. One or more of the following examples may be appropriate. + +Example Swagger Displayed with swaggerv2doc directive +----------------------------------------------------- + +.. swaggerv2doc:: https://gerrit.onap.org/r/gitweb?p=vfc/nfvo/lcm.git;a=blob_plain;f=lcm/swagger/vfc.nslcm.swagger.json + + +Example documenting a REST interface with Sphinx httpdomain directive +--------------------------------------------------------------------- + +.. http:get:: path + + For more information see ``_ + + +Word Document Converted to RST using Pandocs +-------------------------------------------- + +.. toctree:: + :maxdepth: 1 + + ../../submodules/appc.git/docs/APPC API Guide/APPC API Guide -- cgit 1.2.3-korg