From c4e405f6f408d7a61baa8a8d9563e598dddbb7bc Mon Sep 17 00:00:00 2001 From: Eric Debeau Date: Mon, 7 Dec 2020 14:49:52 +0100 Subject: [DOC] Remove warnings from documentation build conf.py => use add_css_file as recommended oom_developer_guide.rst => suppres anchor for nexus link oom_user_guide.rst => - modify anchor for K8S link - add `` fo http example to avoid link to be checked For release-notes-.rst and oom_hardcoded_certificates.rst => - add :orphan: directive because rst file not in toctree Issue-ID: OOM-2646 Signed-off-by: Eric Debeau Change-Id: Icfecde7807e2417a1825f25a1d57a1830c4222a0 --- docs/conf.py | 2 +- docs/oom_developer_guide.rst | 4 ++-- docs/oom_hardcoded_certificates.rst | 2 ++ docs/oom_user_guide.rst | 6 +++--- docs/release-notes-amsterdam.rst | 2 ++ docs/release-notes-beijing.rst | 2 ++ docs/release-notes-casablanca.rst | 2 ++ docs/release-notes-dublin.rst | 2 ++ docs/release-notes-elalto.rst | 2 ++ docs/release-notes-frankfurt.rst | 2 ++ 10 files changed, 20 insertions(+), 6 deletions(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index 8f40e8b817..3b28eb74a8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,4 +12,4 @@ intersphinx_mapping = {} html_last_updated_fmt = '%d-%b-%y %H:%M' def setup(app): - app.add_stylesheet("css/ribbon_onap.css") + app.add_css_file("css/ribbon_onap.css") diff --git a/docs/oom_developer_guide.rst b/docs/oom_developer_guide.rst index fccf453925..3d8cdb1128 100644 --- a/docs/oom_developer_guide.rst +++ b/docs/oom_developer_guide.rst @@ -8,7 +8,7 @@ .. _Helm Charts: https://github.com/kubernetes/charts .. _Kubernetes: https://Kubernetes.io/ .. _Docker: https://www.docker.com/ -.. _Nexus: https://nexus.onap.org/#welcome +.. _Nexus: https://nexus.onap.org/ .. _AWS Elastic Block Store: https://aws.amazon.com/ebs/ .. _Azure File: https://docs.microsoft.com/en-us/azure/storage/files/storage-files-introduction .. _GCE Persistent Disk: https://cloud.google.com/compute/docs/disks/ @@ -1131,7 +1131,7 @@ access to watch the kubernetes events and get service annotation by Kubernetes APIs. The token can be found in the kubectl configuration file *~/.kube/config* -More details can be found here `MSB installation `__. +More details can be found here `MSB installation `_. .. MISC .. ==== diff --git a/docs/oom_hardcoded_certificates.rst b/docs/oom_hardcoded_certificates.rst index 9f6aa1ff0e..c4392c701f 100644 --- a/docs/oom_hardcoded_certificates.rst +++ b/docs/oom_hardcoded_certificates.rst @@ -3,6 +3,8 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2018 Amdocs, Bell Canada, 2020 Nokia Solutions and Networks +:orphan: + .. Links .. _hardcoded-certificates-label: diff --git a/docs/oom_user_guide.rst b/docs/oom_user_guide.rst index 70f19df7b6..ac716a3eb7 100644 --- a/docs/oom_user_guide.rst +++ b/docs/oom_user_guide.rst @@ -12,7 +12,7 @@ .. _Helm Documentation: https://docs.helm.sh/helm/ .. _Helm: https://docs.helm.sh/ .. _Kubernetes: https://Kubernetes.io/ -.. _Kubernetes LoadBalancer: https://kubernetes.io/docs/concepts/services-networking/service/#type-loadbalancer +.. _Kubernetes LoadBalancer: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer .. _user-guide-label: OOM User Guide @@ -414,7 +414,7 @@ below:: Ensure you've disabled any proxy settings the browser you are using to access the portal and then simply access now the new ssl-encrypted URL: -https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm +``https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm`` .. note:: Using the HTTPS based Portal URL the Browser needs to be configured to accept @@ -481,7 +481,7 @@ have been created - a sample from the ONAP Integration labs follows: .. figure:: consulHealth.png :align: center -To see the real-time health of a deployment go to: http://:30270/ui/ +To see the real-time health of a deployment go to: ``http://:30270/ui/`` where a GUI much like the following will be found: diff --git a/docs/release-notes-amsterdam.rst b/docs/release-notes-amsterdam.rst index 79d2e302f4..6fc229696c 100644 --- a/docs/release-notes-amsterdam.rst +++ b/docs/release-notes-amsterdam.rst @@ -5,6 +5,8 @@ .. reserved. .. _release_notes_amsterdam: +:orphan: + ONAP Operations Manager Release Notes ===================================== diff --git a/docs/release-notes-beijing.rst b/docs/release-notes-beijing.rst index 1af7c58dc7..1172a086d2 100644 --- a/docs/release-notes-beijing.rst +++ b/docs/release-notes-beijing.rst @@ -5,6 +5,8 @@ .. reserved. .. _release_notes_beijing: +:orphan: + ONAP Operations Manager Release Notes ===================================== diff --git a/docs/release-notes-casablanca.rst b/docs/release-notes-casablanca.rst index f983c59c9d..6a6a196b6b 100644 --- a/docs/release-notes-casablanca.rst +++ b/docs/release-notes-casablanca.rst @@ -5,6 +5,8 @@ .. reserved. .. _release_notes_casablanca: +:orphan: + ONAP Operations Manager Release Notes ===================================== diff --git a/docs/release-notes-dublin.rst b/docs/release-notes-dublin.rst index e948af5ebb..1974756ea3 100644 --- a/docs/release-notes-dublin.rst +++ b/docs/release-notes-dublin.rst @@ -5,6 +5,8 @@ .. reserved. .. _release_notes_dublin: +:orphan: + ONAP Operations Manager Release Notes ===================================== diff --git a/docs/release-notes-elalto.rst b/docs/release-notes-elalto.rst index 435889ef32..bbbf271a5f 100644 --- a/docs/release-notes-elalto.rst +++ b/docs/release-notes-elalto.rst @@ -5,6 +5,8 @@ .. reserved. .. _release_notes_elalto: +:orphan: + ONAP Operations Manager Release Notes ===================================== diff --git a/docs/release-notes-frankfurt.rst b/docs/release-notes-frankfurt.rst index da3ae2a956..7bd4474487 100644 --- a/docs/release-notes-frankfurt.rst +++ b/docs/release-notes-frankfurt.rst @@ -4,6 +4,8 @@ .. (c) ONAP Project and its contributors .. _release_notes_frankfurt: +:orphan: + ************************************* ONAP Operations Manager Release Notes ************************************* -- cgit 1.2.3-korg