summaryrefslogtreecommitdiffstats
path: root/docs/templates/platform-component
diff options
context:
space:
mode:
authorRich Bennett <rb2745@att.com>2017-09-18 10:01:25 -0400
committerRich Bennett <rb2745@att.com>2017-09-18 10:04:52 -0400
commit3beeced464fd424bda372d098a3b907f577d4155 (patch)
tree29cee7ef4f7467f6d28f9ed5dfa3de807526d91d /docs/templates/platform-component
parent477610ff2502a80550d862a4877cf7bb47af5290 (diff)
Remove linkcheck and add API examples
Part 1 of moviing linkcheck from verify to a CSIT job Added API examples and extensions used to document APIs Change-Id: I5dd536c50930b09bb129e95a9767c97f09c0604b Issue-ID: DOC-82 Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs/templates/platform-component')
-rw-r--r--docs/templates/platform-component/offeredapis.rst23
1 files changed, 20 insertions, 3 deletions
diff --git a/docs/templates/platform-component/offeredapis.rst b/docs/templates/platform-component/offeredapis.rst
index 3e3b5b3d0..55e58bd9b 100644
--- a/docs/templates/platform-component/offeredapis.rst
+++ b/docs/templates/platform-component/offeredapis.rst
@@ -6,7 +6,24 @@ Offered APIs
============
List APIs offered. One or more of the following examples may be appropriate.
-* java docs link
-* rest API swagger json definition displayed with sphinx directive .. swaggerv2doc:
-* a restructured text document
+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 `<https://pythonhosted.org/sphinxcontrib-httpdomain>`_
+
+
+Word Document Converted to RST using Pandocs
+--------------------------------------------
+
+.. toctree::
+ :maxdepth: 1
+
+ ../../submodules/appc.git/docs/APPC API Guide/APPC API Guide