summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCédric Ollivier <cedric.ollivier@orange.com>2022-07-05 14:49:25 +0200
committerCédric Ollivier <cedric.ollivier@orange.com>2022-07-05 14:51:39 +0200
commit2d2241aa28917e38919966817ec1e8873b61da96 (patch)
treec8ac27c634c6e9e23e496f04d3905ac6115874be
parent8990c04e0c32001328c10d477041d9e7745e6274 (diff)
Fix all incorrect anchors detected by linkcheck
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
-rw-r--r--docs/conf.py16
-rw-r--r--docs/guides/onap-developer/architecture/onap-architecture.rst6
-rw-r--r--docs/guides/onap-operator/platformoperations.rst2
-rw-r--r--docs/guides/onap-user/index.rst2
-rw-r--r--docs/release/index.rst2
-rw-r--r--tox.ini2
6 files changed, 7 insertions, 23 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 7b5e2b7d0..eb6e31055 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -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):
diff --git a/docs/guides/onap-developer/architecture/onap-architecture.rst b/docs/guides/onap-developer/architecture/onap-architecture.rst
index 5c45b4afa..8871f211a 100644
--- a/docs/guides/onap-developer/architecture/onap-architecture.rst
+++ b/docs/guides/onap-developer/architecture/onap-architecture.rst
@@ -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
diff --git a/docs/guides/onap-operator/platformoperations.rst b/docs/guides/onap-operator/platformoperations.rst
index cb61b1cbe..666d0e835 100644
--- a/docs/guides/onap-operator/platformoperations.rst
+++ b/docs/guides/onap-operator/platformoperations.rst
@@ -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:**
diff --git a/docs/guides/onap-user/index.rst b/docs/guides/onap-user/index.rst
index adc3a1177..bd7b2260e 100644
--- a/docs/guides/onap-user/index.rst
+++ b/docs/guides/onap-user/index.rst
@@ -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>`
diff --git a/docs/release/index.rst b/docs/release/index.rst
index ca34338a7..8a51b7c84 100644
--- a/docs/release/index.rst
+++ b/docs/release/index.rst
@@ -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 655aa7388..6505b8512 100644
--- 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