From 8a8832ae3497c5cd83e079c77e0f3de84b01b2ee Mon Sep 17 00:00:00 2001 From: Aric Gardner Date: Thu, 2 Apr 2020 17:17:49 -0400 Subject: Intersphinx linking each project now has its own read the docs page example: https://onap-oom-offline-installer.readthedocs.io/ this will redirect to the subproject location in this case: https://onap-doc.readthedocs.io/projects/onap-oom-offline-installer/ Added a new section on the main page: active-projects it shows linking in action. you can click through to the subproject docs from there. you will land on genindex.html This is not ideal To see why this is the case you can run python -m sphinx.ext.intersphinx 'https://onap-doc.readthedocs.io/ projects/onap-oom-offline-installer/en/latest/objects.inv' refer to https://gist.github.com/Aricg/27c739da7c35d201e9ca034df6e30ef6 we must link to one of the avaliable std:label This means that each project should add a lable to its main index page so that we can propery link it. eg, in their index.rst add .. _projectname-mainindex: or something we can agree on. Issue-ID: CIMAN-33 Signed-off-by: Aric Gardner Change-Id: I0e1b506d113b9fbbcf2cb854482dfb557d8012b7 --- docs/conf.py | 74 +++++++++++++++++++++++++++++++++ docs/guides/active-projects/index.rst | 78 +++++++++++++++++++++++++++++++++++ docs/index.rst | 4 +- 3 files changed, 155 insertions(+), 1 deletion(-) create mode 100644 docs/guides/active-projects/index.rst diff --git a/docs/conf.py b/docs/conf.py index 460860cda..8b3ac0568 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,7 @@ from docs_conf.conf import * branch = 'latest' +doc_url = 'https://onap-doc.readthedocs.io/projects' master_doc = 'index' linkcheck_ignore = [ @@ -9,6 +10,79 @@ linkcheck_ignore = [ intersphinx_mapping = {} +intersphinx_mapping['onap-oom-offline-installer'] = ('{}/onap-oom-offline-installer/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-oom'] = ('{}/onap-oom/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-oparent-cia'] = ('{}/onap-oparent-cia/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-music-distributed-kv-store'] = ('{}/onap-music-distributed-kv-store/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-dmaap-dbcapi'] = ('{}/onap-dmaap-dbcapi/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-msb-swagger-sdk'] = ('{}/onap-msb-swagger-sdk/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-msb-java-sdk'] = ('{}/onap-msb-java-sdk/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-holmes-engine-management'] = ('{}/onap-holmes-engine-management/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-multicloud-azure'] = ('{}/onap-multicloud-azure/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-modeling-etsicatalog'] = ('{}/onap-modeling-etsicatalog/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-modeling-toscaparsers'] = ('{}/onap-modeling-toscaparsers/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-modeling-modelspec'] = ('{}/onap-modeling-modelspec/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-vnfrqts-requirements'] = ('{}/onap-vnfrqts-requirements/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-vnfrqts-guidelines'] = ('{}/onap-vnfrqts-guidelines/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-dmaap-messagerouter-messageservice'] = ('{}/onap-dmaap-messagerouter-messageservice/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-externalapi-nbi'] = ('{}/onap-externalapi-nbi/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-logging-analytics'] = ('{}/onap-logging-analytics/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-dmaap-buscontroller'] = ('{}/onap-dmaap-buscontroller/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-dmaap-datarouter'] = ('{}/onap-dmaap-datarouter/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-music'] = ('{}/onap-music/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-sdc-sdc-workflow-designer'] = ('{}/onap-sdc-sdc-workflow-designer/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-sdc-sdc-tosca'] = ('{}/onap-sdc-sdc-tosca/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-vvp-documentation'] = ('{}/onap-vvp-documentation/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-logging-analytics-pomba-pomba-audit-common'] = ('{}/onap-logging-analytics-pomba-pomba-audit-common/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-msb-apigateway'] = ('{}/onap-msb-apigateway/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-msb-discovery'] = ('{}/onap-msb-discovery/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-vnfrqts-testcases'] = ('{}/onap-vnfrqts-testcases/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-vnfrqts-usecases'] = ('{}/onap-vnfrqts-usecases/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-policy-parent'] = ('{}/onap-policy-parent/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-vfc-nfvo-lcm'] = ('{}/onap-vfc-nfvo-lcm/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-vfc-nfvo-driver-vnfm-svnfm'] = ('{}/onap-vfc-nfvo-driver-vnfm-svnfm/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-holmes-rule-management'] = ('{}/onap-holmes-rule-management/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-policy-engine'] = ('{}/onap-policy-engine/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-portal'] = ('{}/onap-portal/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-cli'] = ('{}/onap-cli/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-aaf-certservice'] = ('{}/onap-aaf-certservice/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-ccsdk-cds'] = ('{}/onap-ccsdk-cds/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-ccsdk-apps'] = ('{}/onap-ccsdk-apps/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-sdnc-oam'] = ('{}/onap-sdnc-oam/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-ccsdk-platform-plugins'] = ('{}/onap-ccsdk-platform-plugins/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-ccsdk-dashboard'] = ('{}/onap-ccsdk-dashboard/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-ccsdk-features'] = ('{}/onap-ccsdk-features/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-ccsdk-distribution'] = ('{}/onap-ccsdk-distribution/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-so-libs'] = ('{}/onap-so-libs/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-so'] = ('{}/onap-so/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-integration'] = ('{}/onap-integration/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-aaf-sms'] = ('{}/onap-aaf-sms/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-appc'] = ('{}/onap-appc/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-appc-deployment'] = ('{}/onap-appc-deployment/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-optf-cmso'] = ('{}/onap-optf-cmso/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-optf-osdf'] = ('{}/onap-optf-osdf/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-optf-has'] = ('{}/onap-optf-has/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-sdc-sdc-distribution-client'] = ('{}/onap-sdc-sdc-distribution-client/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-sdc-sdc-docker-base'] = ('{}/onap-sdc-sdc-docker-base/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-sdc'] = ('{}/onap-sdc/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-clamp'] = ('{}/onap-clamp/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-aai-event-client'] = ('{}/onap-aai-event-client/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-aai-sparky-be'] = ('{}/onap-aai-sparky-be/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-aai-esr-gui'] = ('{}/onap-aai-esr-gui/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-aai-esr-server'] = ('{}/onap-aai-esr-server/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-multicloud-k8s'] = ('{}/onap-multicloud-k8s/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-multicloud-framework'] = ('{}/onap-multicloud-framework/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-dcaegen2'] = ('{}/onap-dcaegen2/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-vnfsdk-model'] = ('{}/onap-vnfsdk-model/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-usecase-ui'] = ('{}/onap-usecase-ui/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-vid'] = ('{}/onap-vid/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-aaf-authz'] = ('{}/onap-aaf-authz/en/%s'.format(doc_url) % branch, None) + + + + + html_last_updated_fmt = '%d-%b-%y %H:%M' def setup(app): diff --git a/docs/guides/active-projects/index.rst b/docs/guides/active-projects/index.rst new file mode 100644 index 000000000..c05067fdd --- /dev/null +++ b/docs/guides/active-projects/index.rst @@ -0,0 +1,78 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2020 + +.. _active_projects: + +All Active Projects +=================== + +| :ref:`onap-oom-offline-installer ` +| :ref:`onap-oom ` +| :ref:`onap-oparent-cia ` +| :ref:`onap-music-distributed-kv-store ` +| :ref:`onap-dmaap-dbcapi ` +| :ref:`onap-msb-swagger-sdk ` +| :ref:`onap-msb-java-sdk ` +| :ref:`onap-holmes-engine-management ` +| :ref:`onap-multicloud-azure ` +| :ref:`onap-modeling-etsicatalog ` +| :ref:`onap-modeling-toscaparsers ` +| :ref:`onap-modeling-modelspec ` +| :ref:`onap-vnfrqts-requirements ` +| :ref:`onap-vnfrqts-guidelines ` +| :ref:`onap-dmaap-messagerouter-messageservice ` +| :ref:`onap-externalapi-nbi ` +| :ref:`onap-logging-analytics ` +| :ref:`onap-dmaap-buscontroller ` +| :ref:`onap-dmaap-datarouter ` +| :ref:`onap-music ` +| :ref:`onap-sdc-sdc-workflow-designer ` +| :ref:`onap-sdc-sdc-tosca ` +| :ref:`onap-vvp-documentation ` +| :ref:`onap-logging-analytics-pomba-pomba-audit-common ` +| :ref:`onap-msb-apigateway ` +| :ref:`onap-msb-discovery ` +| :ref:`onap-vnfrqts-testcases ` +| :ref:`onap-vnfrqts-usecases ` +| :ref:`onap-policy-parent ` +| :ref:`onap-vfc-nfvo-lcm ` +| :ref:`onap-vfc-nfvo-driver-vnfm-svnfm ` +| :ref:`onap-holmes-rule-management ` +| :ref:`onap-policy-engine ` +| :ref:`onap-portal ` +| :ref:`onap-cli ` +| :ref:`onap-aaf-certservice ` +| :ref:`onap-ccsdk-cds ` +| :ref:`onap-ccsdk-apps ` +| :ref:`onap-sdnc-oam ` +| :ref:`onap-ccsdk-platform-plugins ` +| :ref:`onap-ccsdk-dashboard ` +| :ref:`onap-ccsdk-features ` +| :ref:`onap-ccsdk-distribution ` +| :ref:`onap-so-libs ` +| :ref:`onap-so ` +| :ref:`onap-integration ` +| :ref:`onap-aai-aai-common ` +| :ref:`onap-aaf-sms ` +| :ref:`onap-appc ` +| :ref:`onap-appc-deployment ` +| :ref:`onap-optf-cmso ` +| :ref:`onap-optf-osdf ` +| :ref:`onap-optf-has ` +| :ref:`onap-sdc-sdc-distribution-client ` +| :ref:`onap-sdc-sdc-docker-base ` +| :ref:`onap-sdc ` +| :ref:`onap-clamp ` +| :ref:`onap-aai-event-client ` +| :ref:`onap-aai-sparky-be ` +| :ref:`onap-aai-esr-gui ` +| :ref:`onap-aai-esr-server ` +| :ref:`onap-multicloud-k8s ` +| :ref:`onap-multicloud-framework ` +| :ref:`onap-dcaegen2 ` +| :ref:`onap-vnfsdk-model ` +| :ref:`onap-usecase-ui ` +| :ref:`onap-vid ` +| :ref:`onap-aaf-authz ` + diff --git a/docs/index.rst b/docs/index.rst index ee6933c21..6ee7a5d1c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -54,7 +54,8 @@ Please find some guidance here on the content of ONAP documentation: | | and PNFs can accelerate the optimal usage of this ONAP environment. The guidelines | | | on VNF/PNF requirements facilitates synchronized and aligned activities for all participants. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - + | :ref:`Active Projects ` | Simple listing of all Active projects | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ .. toctree:: @@ -70,3 +71,4 @@ Please find some guidance here on the content of ONAP documentation: guides/onap-user/index guides/onap-developer/index guides/onap-provider/index + guides/active-projects/index -- cgit 1.2.3-korg