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 <agardner@linuxfoundation.org>
Change-Id: I0e1b506d113b9fbbcf2cb854482dfb557d8012b7

diff --git a/docs/conf.py b/docs/conf.py
index 460860c..8b3ac05 100644 (file)
--- 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 (file)
index 0000000..c05067f
--- /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 <onap-oom-offline-installer:genindex>`
+| :ref:`onap-oom <onap-oom:genindex>`
+| :ref:`onap-oparent-cia <onap-oparent-cia:genindex>`
+| :ref:`onap-music-distributed-kv-store <onap-music-distributed-kv-store:genindex>`
+| :ref:`onap-dmaap-dbcapi <onap-dmaap-dbcapi:genindex>`
+| :ref:`onap-msb-swagger-sdk <onap-msb-swagger-sdk:genindex>`
+| :ref:`onap-msb-java-sdk <onap-msb-java-sdk:genindex>`
+| :ref:`onap-holmes-engine-management <onap-holmes-engine-management:genindex>`
+| :ref:`onap-multicloud-azure <onap-multicloud-azure:genindex>`
+| :ref:`onap-modeling-etsicatalog <onap-modeling-etsicatalog:genindex>`
+| :ref:`onap-modeling-toscaparsers <onap-modeling-toscaparsers:genindex>`
+| :ref:`onap-modeling-modelspec <onap-modeling-modelspec:genindex>`
+| :ref:`onap-vnfrqts-requirements <onap-vnfrqts-requirements:genindex>`
+| :ref:`onap-vnfrqts-guidelines <onap-vnfrqts-guidelines:genindex>`
+| :ref:`onap-dmaap-messagerouter-messageservice <onap-dmaap-messagerouter-messageservice:genindex>`
+| :ref:`onap-externalapi-nbi <onap-externalapi-nbi:genindex>`
+| :ref:`onap-logging-analytics <onap-logging-analytics:genindex>`
+| :ref:`onap-dmaap-buscontroller <onap-dmaap-buscontroller:genindex>`
+| :ref:`onap-dmaap-datarouter <onap-dmaap-datarouter:genindex>`
+| :ref:`onap-music <onap-music:genindex>`
+| :ref:`onap-sdc-sdc-workflow-designer <onap-sdc-sdc-workflow-designer:genindex>`
+| :ref:`onap-sdc-sdc-tosca <onap-sdc-sdc-tosca:genindex>`
+| :ref:`onap-vvp-documentation <onap-vvp-documentation:genindex>`
+| :ref:`onap-logging-analytics-pomba-pomba-audit-common <onap-logging-analytics-pomba-pomba-audit-common:genindex>`
+| :ref:`onap-msb-apigateway <onap-msb-apigateway:genindex>`
+| :ref:`onap-msb-discovery <onap-msb-discovery:genindex>`
+| :ref:`onap-vnfrqts-testcases <onap-vnfrqts-testcases:genindex>`
+| :ref:`onap-vnfrqts-usecases <onap-vnfrqts-usecases:genindex>`
+| :ref:`onap-policy-parent <onap-policy-parent:genindex>`
+| :ref:`onap-vfc-nfvo-lcm <onap-vfc-nfvo-lcm:genindex>`
+| :ref:`onap-vfc-nfvo-driver-vnfm-svnfm <onap-vfc-nfvo-driver-vnfm-svnfm:genindex>`
+| :ref:`onap-holmes-rule-management <onap-holmes-rule-management:genindex>`
+| :ref:`onap-policy-engine <onap-policy-engine:genindex>`
+| :ref:`onap-portal <onap-portal:genindex>`
+| :ref:`onap-cli <onap-cli:genindex>`
+| :ref:`onap-aaf-certservice <onap-aaf-certservice:genindex>`
+| :ref:`onap-ccsdk-cds <onap-ccsdk-cds:genindex>`
+| :ref:`onap-ccsdk-apps <onap-ccsdk-apps:genindex>`
+| :ref:`onap-sdnc-oam <onap-sdnc-oam:genindex>`
+| :ref:`onap-ccsdk-platform-plugins <onap-ccsdk-platform-plugins:genindex>`
+| :ref:`onap-ccsdk-dashboard <onap-ccsdk-dashboard:genindex>`
+| :ref:`onap-ccsdk-features <onap-ccsdk-features:genindex>`
+| :ref:`onap-ccsdk-distribution <onap-ccsdk-distribution:genindex>`
+| :ref:`onap-so-libs <onap-so-libs:genindex>`
+| :ref:`onap-so <onap-so:genindex>`
+| :ref:`onap-integration <onap-integration:genindex>`
+| :ref:`onap-aai-aai-common <onap-aai-aai-common:genindex>`
+| :ref:`onap-aaf-sms <onap-aaf-sms:genindex>`
+| :ref:`onap-appc <onap-appc:genindex>`
+| :ref:`onap-appc-deployment <onap-appc-deployment:genindex>`
+| :ref:`onap-optf-cmso <onap-optf-cmso:genindex>`
+| :ref:`onap-optf-osdf <onap-optf-osdf:genindex>`
+| :ref:`onap-optf-has <onap-optf-has:genindex>`
+| :ref:`onap-sdc-sdc-distribution-client <onap-sdc-sdc-distribution-client:genindex>`
+| :ref:`onap-sdc-sdc-docker-base <onap-sdc-sdc-docker-base:genindex>`
+| :ref:`onap-sdc <onap-sdc:genindex>`
+| :ref:`onap-clamp <onap-clamp:genindex>`
+| :ref:`onap-aai-event-client <onap-aai-event-client:genindex>`
+| :ref:`onap-aai-sparky-be <onap-aai-sparky-be:genindex>`
+| :ref:`onap-aai-esr-gui <onap-aai-esr-gui:genindex>`
+| :ref:`onap-aai-esr-server <onap-aai-esr-server:genindex>`
+| :ref:`onap-multicloud-k8s <onap-multicloud-k8s:genindex>`
+| :ref:`onap-multicloud-framework <onap-multicloud-framework:genindex>`
+| :ref:`onap-dcaegen2 <onap-dcaegen2:genindex>`
+| :ref:`onap-vnfsdk-model <onap-vnfsdk-model:genindex>`
+| :ref:`onap-usecase-ui <onap-usecase-ui:genindex>`
+| :ref:`onap-vid <onap-vid:genindex>`
+| :ref:`onap-aaf-authz <onap-aaf-authz:genindex>`
+

diff --git a/docs/index.rst b/docs/index.rst
index ee6933c..6ee7a5d 100644 (file)
--- 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 <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