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>
'sphinx.ext.imgmath',
'sphinx.ext.viewcode',
'sphinxcontrib.blockdiag',
'sphinx.ext.imgmath',
'sphinx.ext.viewcode',
'sphinxcontrib.blockdiag',
- 'sphinxcontrib.seqdiag'
+ 'sphinxcontrib.seqdiag',
+ 'sphinx.ext.ifconfig',
+ 'sphinx.ext.todo',
+ 'sphinxcontrib.httpdomain',
+ 'sphinxcontrib.plantuml',
+ 'sphinxcontrib.swaggerdoc'
]
# Font path for seqdiag
]
# Font path for seqdiag
# Patterns to ignore in linkcheck builder
linkcheck_ignore = [r'http://localhost:\d+/']
# Patterns to ignore in linkcheck builder
linkcheck_ignore = [r'http://localhost:\d+/']
aai/search-data-service <../submodules/aai/search-data-service.git/docs/index>
optf/has <../submodules/optf/has.git/docs/index>
dcaegen2 <../submodules/dcaegen2.git/docs/index>
aai/search-data-service <../submodules/aai/search-data-service.git/docs/index>
optf/has <../submodules/optf/has.git/docs/index>
dcaegen2 <../submodules/dcaegen2.git/docs/index>
- aaf/authz <../submodules/aaf/authz.git/docs/index>
+ aaf/authz <../submodules/aaf/authz.git/docs/index>
============
List APIs offered. One or more of the following examples may be appropriate.
============
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
sphinxcontrib-httpdomain
sphinxcontrib-blockdiag
sphinxcontrib-seqdiag
sphinxcontrib-httpdomain
sphinxcontrib-blockdiag
sphinxcontrib-seqdiag
+sphinxcontrib-swaggerdoc
+sphinxcontrib-plantuml
+sphinxcontrib-httpdomain
sphinx_bootstrap_theme>=0.4.11
sphinx_bootstrap_theme>=0.4.11
-envlist = docs,docs-linkcheck
skipsdist = true
[testenv:docs]
skipsdist = true
[testenv:docs]
[testenv:docs-linkcheck]
deps = -r{toxinidir}/etc/requirements.txt
[testenv:docs-linkcheck]
deps = -r{toxinidir}/etc/requirements.txt
-commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
\ No newline at end of file
+commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck