From b921b99f27d55e46db2b72b5987ffacb1f781857 Mon Sep 17 00:00:00 2001 From: Rich Bennett Date: Fri, 17 Nov 2017 08:28:37 -0500 Subject: Improve References to User Guides Insert Note before DW User Guide Links Add index entries to for major sections topics Remove requirement.txt workarounds after RTD change to recognize readthedocs.yml in the root folder Update release notes Change-Id: Id57ff10a055ea1d1e5394170d5b5b401d51d58ab Issue-ID: DOC-60 Signed-off-by: Rich Bennett --- docs/guides/onap-developer/apiref/index.rst | 2 ++ docs/guides/onap-developer/architecture/index.rst | 2 ++ docs/guides/onap-developer/developing/index.rst | 2 ++ docs/guides/onap-developer/how-to-use-docs/addendum.rst | 2 -- docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst | 2 -- docs/guides/onap-developer/how-to-use-docs/index.rst | 5 +++++ docs/guides/onap-developer/settingup/fullonap.rst | 2 ++ 7 files changed, 13 insertions(+), 4 deletions(-) (limited to 'docs/guides/onap-developer') diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst index b14acc170..db4cd6a51 100644 --- a/docs/guides/onap-developer/apiref/index.rst +++ b/docs/guides/onap-developer/apiref/index.rst @@ -2,6 +2,8 @@ International License. http://creativecommons.org/licenses/by/4.0 Copyright 2017 AT&T Intellectual Property. All rights reserved. +.. index:: API Reference + .. _doc-apiref: REST API Reference diff --git a/docs/guides/onap-developer/architecture/index.rst b/docs/guides/onap-developer/architecture/index.rst index 960cda23b..d4f38d9cf 100644 --- a/docs/guides/onap-developer/architecture/index.rst +++ b/docs/guides/onap-developer/architecture/index.rst @@ -3,6 +3,8 @@ International License. http://creativecommons.org/licenses/by/4.0 Copyright 2017 AT&T Intellectual Property. All rights reserved. +.. index:: Platform Architecture + .. _doc-architecture: Architecture diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index c5690ac2a..c6528f12c 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -2,6 +2,8 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 AT&T Intellectual Property. All rights reserved. +.. index:: Developer Guides + .. _doc_onap-developer_guide_projects: Developing ONAP diff --git a/docs/guides/onap-developer/how-to-use-docs/addendum.rst b/docs/guides/onap-developer/how-to-use-docs/addendum.rst index eccd0022a..2d8a25cfa 100644 --- a/docs/guides/onap-developer/how-to-use-docs/addendum.rst +++ b/docs/guides/onap-developer/how-to-use-docs/addendum.rst @@ -60,8 +60,6 @@ You can add html content that only appears in html output by using the This line will be shown only in html version. -.. index:: single: indices - Creating Indices ---------------- diff --git a/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst b/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst index 8fd9a730b..9c5822d2b 100644 --- a/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst +++ b/docs/guides/onap-developer/how-to-use-docs/documentation-guide.rst @@ -100,7 +100,6 @@ A starting structure is shown below and may change as content is integrated for each release. Other ONAP projects will provide content that is referenced from this structure. -.. index:: master :: @@ -133,7 +132,6 @@ ONAP jenkins jobs that verify and merge documentation are triggered by RST file changes in the top level docs directory and below. -.. index:: licensing Licensing --------- diff --git a/docs/guides/onap-developer/how-to-use-docs/index.rst b/docs/guides/onap-developer/how-to-use-docs/index.rst index a73ae6fb3..6f1dd2d33 100644 --- a/docs/guides/onap-developer/how-to-use-docs/index.rst +++ b/docs/guides/onap-developer/how-to-use-docs/index.rst @@ -12,3 +12,8 @@ Creating Documentation include-documentation converting-formats addendum + +.. toctree:: + :hidden: + + update-review.rst diff --git a/docs/guides/onap-developer/settingup/fullonap.rst b/docs/guides/onap-developer/settingup/fullonap.rst index 859005f55..6d3d891da 100644 --- a/docs/guides/onap-developer/settingup/fullonap.rst +++ b/docs/guides/onap-developer/settingup/fullonap.rst @@ -7,6 +7,8 @@ :depth: 2 .. +.. index:: Setting Up Full ONAP + ======================== **Setting Up Full ONAP** -- cgit 1.2.3-korg