From 5b9d80a4e9175cfd6bd7f2be33c540053f726005 Mon Sep 17 00:00:00 2001 From: Guillaume Lambert Date: Tue, 2 Feb 2021 15:07:08 +0100 Subject: [PATCH] [DOC] Fix tox docs-linkcheck profile issues - ignore URLs logically unreachable such as about:config - and create a code block for the git clone URL that is not reachable - ignore URLs with anchors (especially the ones ill-generated from external objects, mainly onap-integration) - enforce tox docs-lincheck profile Issue-ID: DOC-692 Signed-off-by: Guillaume Lambert Change-Id: I619d8d5697a35bf2bdf3ee2ed59ca9f5733e7802 --- docs/conf.py | 12 ++++++++++++ docs/guides/onap-user/vfw-design-tutorial/index.rst | 8 ++++++-- tox.ini | 2 +- 3 files changed, 19 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 0c79cc989..33552e829 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -81,6 +81,18 @@ intersphinx_mapping['onap-vid'] = ('{}/onap-vid/en/%s'.format(doc_url) % branch, intersphinx_mapping['onap-aaf-authz'] = ('{}/onap-aaf-authz/en/%s'.format(doc_url) % branch, None) +linkcheck_ignore = [ + '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', +] diff --git a/docs/guides/onap-user/vfw-design-tutorial/index.rst b/docs/guides/onap-user/vfw-design-tutorial/index.rst index 0aa002314..171d295d2 100644 --- a/docs/guides/onap-user/vfw-design-tutorial/index.rst +++ b/docs/guides/onap-user/vfw-design-tutorial/index.rst @@ -96,8 +96,12 @@ Let us start by creating the VLM 2. Create Vendor Software Product (VSP) -Prerequisite: Download VNF Heat package from gerrit (git clone "https://gerrit.onap.org/r/demo") and copy -the required HEAT package & use it while upload the package +Prerequisite: Download VNF Heat package from gerrit + +.. code: bash + git clone "https://gerrit.onap.org/r/demo" + +and copy the required HEAT package & use it while upload the package A. Go to SDC Home → ONBOARD → WORKSPACE → CREATE NEW VSP (complete all the fields, click on Network Package checkbox then click create) diff --git a/tox.ini b/tox.ini index 3c93b2958..6c8827d15 100644 --- a/tox.ini +++ b/tox.ini @@ -28,7 +28,7 @@ whitelist_externals = [testenv:docs-linkcheck] basepython = python3 deps = -r{toxinidir}/etc/requirements.txt -commands = - sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck +commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck [testenv:spellcheck] basepython = python3 -- 2.16.6