diff options
author | Eric Debeau <eric.debeau@orange.com> | 2021-10-04 21:53:46 +0200 |
---|---|---|
committer | Eric Debeau <eric.debeau@orange.com> | 2021-10-14 15:01:46 +0000 |
commit | b25147b6a0e8313b26a22a932ff890b858fdbe3e (patch) | |
tree | 53337f4fcbf655bf6eac115ef331bd715cb56522 /docs/conf.py | |
parent | 7da7f2ced1347a94cd0d722c24da1f347ce54b11 (diff) |
[DOC] Correct ReDoc API documentationhonolulu
Existing solution based on javascript is not working
- solution based on _downloads reference
Use sphinxcontrib-redoc package
- Update conf.py to add the required extensions
- Update conf.py to add ReDoc API documentation
- Add sphinxcontrib-redoc in requirements-docs.txt
- Remove redoc directory
- Copy Swagger JSON file in swagger repo
- Rename Swagger JSON file
- Correct Swagger JSON file to delete bad characters
Small editorial corrections
- Update doc/architecture.rst
Issue-ID: EXTAPI-599
Signed-off-by: Eric Debeau <eric.debeau@orange.com>
Change-Id: I3c2b52ff072f81f5554046498f0cf8419cc3f342
(cherry picked from commit 7471bd7e10998bc5cdfe591ed42b0f4c9eb41205)
Diffstat (limited to 'docs/conf.py')
-rw-r--r-- | docs/conf.py | 39 |
1 files changed, 38 insertions, 1 deletions
diff --git a/docs/conf.py b/docs/conf.py index 5082a4b..62bf96d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -11,5 +11,42 @@ intersphinx_mapping = {} html_last_updated_fmt = '%d-%b-%y %H:%M' +extensions = ['sphinxcontrib.blockdiag', 'sphinxcontrib.redoc'] + +redoc = [ + { + 'name': 'Hub API', + 'page': 'offeredapis/hub', + 'spec': 'offeredapis/swagger/hub.json', + 'embed': True + }, + { + 'name': 'Service Catalog API', + 'page': 'offeredapis/service_catalog', + 'spec': 'offeredapis/swagger/service_catalog.json', + 'embed': True + }, + { + 'name': 'Service Inventory API', + 'page': 'offeredapis/service_inventory', + 'spec': 'offeredapis/swagger/service_inventory.json', + 'embed': True + }, + { + 'name': 'Service Order API', + 'page': 'offeredapis/service_order', + 'spec': 'offeredapis/swagger/service_order.json', + 'embed': True + }, + { + 'name': 'Status API', + 'page': 'offeredapis/status', + 'spec': 'offeredapis/swagger/status.json', + 'embed': True + } + ] + +redoc_uri = 'https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js' + def setup(app): - app.add_css_file("css/ribbon.css")
\ No newline at end of file + app.add_css_file("css/ribbon.css") |