diff options
| author |   halil.cakal <halil.cakal@est.tech> | 2022-11-16 13:24:44 +0000 |
|---|---|---|
| committer | halil.cakal <halil.cakal@est.tech> | 2022-11-18 10:18:15 +0000 |
| commit | 3607907428bb3c8cd569b7d3cb05480d645893d9 (patch) | |
| tree | f430054eabdbeb262400674ea7239963b01aa754 /docs | |
| parent | ed0b18250bab22f6cdfbb570f2495301cf669d77 (diff) | |
Fix breaking API documentation generation
Add extension lfdocs-conf and replace ROBOT_VENV with ROBOT3_VENV
Issue-ID: CCSDK-3815
Change-Id: I565ee15bd5862cca0365d153358941b27befb94a
Signed-off-by: halil.cakal <halil.cakal@est.tech>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 21 | ||||
| -rw-r--r-- | docs/requirements-docs.txt | 2 |
2 files changed, 22 insertions, 1 deletions
diff --git a/docs/conf.py b/docs/conf.py index a9c42b67..ee7f207a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -22,7 +22,9 @@ extensions = [ 'sphinxcontrib.blockdiag', 'sphinxcontrib.seqdiag', 'sphinxcontrib.swaggerdoc', - 'sphinxcontrib.plantuml' + 'sphinxcontrib.plantuml', + 'sphinxcontrib.redoc', + 'sphinx_tabs.tabs' ] # @@ -32,6 +34,23 @@ extensions = [ branch = 'latest' +redoc = [ + { + 'name': 'PMS API', + 'page': 'offeredapis/pms-api', + 'spec': './offeredapis/swagger/pms-api.json', + 'embed': True, + }, + { + 'name': 'A1 ADAPTER API', + 'page': 'offeredapis/a1-adapter-api', + 'spec': './offeredapis/swagger/a1-adapter-api.json', + 'embed': True, + } + ] + +redoc_uri = 'https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js' + intersphinx_mapping = {} doc_url = 'https://docs.onap.org/projects' master_doc = 'index' diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 71df2ab0..009b997a 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -1,3 +1,4 @@ +lfdocs-conf sphinx>=4.2.0 # BSD sphinx-rtd-theme>=1.0.0 # MIT sphinxcontrib-blockdiag # BSD @@ -5,3 +6,4 @@ sphinxcontrib-seqdiag # BSD sphinxcontrib-swaggerdoc sphinxcontrib-spelling sphinxcontrib-plantuml +sphinxcontrib-redoc |