Intersphinx linking 47/105047/1
authorAric Gardner <agardner@linuxfoundation.org>
Thu, 2 Apr 2020 21:17:49 +0000 (17:17 -0400)
committerAric Gardner <agardner@linuxfoundation.org>
Thu, 2 Apr 2020 21:26:02 +0000 (17:26 -0400)
commit8a8832ae3497c5cd83e079c77e0f3de84b01b2ee
treed0b94ad7a8971797dbd1f96ee3b45a4abd2f2d19
parent91124a2e542d7c9f8259437e737c95db13dc1437
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
docs/conf.py
docs/guides/active-projects/index.rst [new file with mode: 0644]
docs/index.rst