Fix all incorrect anchors detected by linkcheck 87/129787/1
authorCédric Ollivier <cedric.ollivier@orange.com>
Tue, 5 Jul 2022 12:49:25 +0000 (14:49 +0200)
committerCédric Ollivier <cedric.ollivier@orange.com>
Tue, 5 Jul 2022 12:52:21 +0000 (14:52 +0200)
It leverages the doc directive which suits this cases.
There is no longer link ignored by linkcheck.

Issue-ID: DOC-782

Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
Change-Id: I416e378f28789504eee5b44778c8c8edc1e7723f
(cherry picked from commit 2d2241aa28917e38919966817ec1e8873b61da96)

docs/conf.py
docs/guides/onap-developer/architecture/onap-architecture.rst
docs/guides/onap-operator/platformoperations.rst
docs/guides/onap-user/index.rst
docs/release/index.rst
tox.ini

index d32dcc6..54b2c5f 100644 (file)
@@ -55,22 +55,6 @@ intersphinx_mapping['onap-vnfsdk-model'] = ('{}/onap-vnfsdk-model/en/%s'.format(
 branch = 'latest'
 intersphinx_mapping['onap-osa'] = ('{}/onap-osa/en/%s'.format(doc_url) % branch, None)
 
-# Linkcheck
-linkcheck_ignore = [
-    'http://localhost',
-    'https://example.com',
-    'about:config',
-    # this URL is not directly reachable and must be configured in the system hosts file.
-    'https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm',
-    # anchor issues
-    'https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases_release.html#.*',
-    'https://docs.linuxfoundation.org/docs/communitybridge/easycla/contributors/contribute-to-a-gerrit-project#.*',
-    'https://docs.onap.org/projects/onap-integration/en/latest/docs_robot.html#docs-robot',
-    'https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases_release.html#docs-usecases-release',
-    'https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases.html#docs-usecases',
-    'https://docs.onap.org/projects/onap-integration/en/latest/usecases/release_non_functional_requirements.html#release-non-functional-requirements',
-]
-
 html_last_updated_fmt = '%d-%b-%y %H:%M'
 
 def setup(app):
index 5c45b4a..8871f21 100644 (file)
@@ -818,7 +818,7 @@ Use cases
 Various use cases have been tested for the Release. Use case examples are
 listed below. See detailed information on use cases, functional requirements,
 and automated use cases can be found here:
-:ref:`Verified Use Cases<onap-integration:docs_usecases_release>`.
+:doc:`Verified Use Cases<onap-integration:docs_usecases_release>`.
 
 - E2E Network Slicing
 - 5G OOF (ONAP Optimization Framework) SON (Self-Organized Network)
@@ -828,7 +828,7 @@ Functional requirements
 -----------------------
 Various functional requirements have been tested for the Release. Detailed
 information can be found in the
-:ref:`Verified Use Cases<onap-integration:docs_usecases_release>`.
+:doc:`Verified Use Cases<onap-integration:docs_usecases_release>`.
 
 - xNF Integration
 
@@ -899,4 +899,4 @@ See the Resources page on `ONAP.org <https://www.onap.org/resources>`_
 .. |image11| image:: media/ONAP-mdons.png
    :width: 800px
 .. |image12| image:: media/ONAP-IntentBasedNetworking.png
-   :width: 800px
\ No newline at end of file
+   :width: 800px
index cb61b1c..666d0e8 100644 (file)
@@ -38,7 +38,7 @@ functions
    :maxdepth: 2
    :titlesonly:
 
-:ref:`RobotFramework<onap-integration:docs_robot>`
+:doc:`RobotFramework<onap-integration:docs_robot>`
 
 **Interface Health can be checked via Consul:**
 
index adc3a11..bd7b226 100644 (file)
@@ -33,4 +33,4 @@ In the following page you find all use cases and functional requirements
 which have been officially verified in the actual release by the ONAP
 community.
 
-* :ref:`Verified Use Cases<onap-integration:docs_usecases_release>`
+* :doc:`Verified Use Cases<onap-integration:docs_usecases_release>`
index ca34338..8a51b7c 100644 (file)
@@ -254,7 +254,7 @@ Tests & Integration
 
 .. important::
    Some non-functional requirements are not fully finalized. Please, check details
-   on the :ref:`Integration<onap-integration:release_non_functional_requirements>`
+   on the :doc:`Integration<usecases/release_non_functional_requirements>`
 
 Project Specific Release Notes
 ==============================
diff --git a/tox.ini b/tox.ini
index 655aa73..6505b85 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -49,7 +49,7 @@ deps =
     -r{toxinidir}/etc/requirements-docs.txt
     -c{toxinidir}/etc/upper-constraints.os.txt
     -c{toxinidir}/etc/upper-constraints.onap.txt
-commands = sphinx-build -q -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
+commands = sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
 
 [testenv:spellcheck]
 basepython = python3