diff options
| author |   Aric Gardner <agardner@linuxfoundation.org> | 2020-04-02 17:17:49 -0400 |
|---|---|---|
| committer | Aric Gardner <agardner@linuxfoundation.org> | 2020-04-02 17:26:02 -0400 |
| commit | 8a8832ae3497c5cd83e079c77e0f3de84b01b2ee (patch) | |
| tree | d0b94ad7a8971797dbd1f96ee3b45a4abd2f2d19 /docs/index.rst | |
| parent | 91124a2e542d7c9f8259437e737c95db13dc1437 (diff) | |
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
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 4 |
1 files changed, 3 insertions, 1 deletions
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 <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 |