Merge "[DOC] Fix tox docs-linkcheck profile issues" into guilin
authorAndreas Geissler <andreas-geissler@telekom.de>
Thu, 18 Feb 2021 16:11:49 +0000 (16:11 +0000)
committerGerrit Code Review <gerrit@onap.org>
Thu, 18 Feb 2021 16:11:49 +0000 (16:11 +0000)
docs/conf.py
docs/guides/onap-user/vfw-design-tutorial/index.rst
tox.ini

index cdca704..4dfc64e 100644 (file)
@@ -88,6 +88,20 @@ intersphinx_mapping['onap-vnfrqts-guidelines'] = ('{}/onap-vnfrqts-guidelines/en
 intersphinx_mapping['onap-vnfrqts-testcases'] = ('{}/onap-vnfrqts-testcases/en/%s'.format(doc_url) % branch, None)
 intersphinx_mapping['onap-vnfrqts-usecases'] = ('{}/onap-vnfrqts-usecases/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/guilin/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/guilin/docs_robot.html#docs-robot',
+   'https://docs.onap.org/projects/onap-integration/en/guilin/docs_usecases_release.html#docs-usecases-release',
+   'https://docs.onap.org/projects/onap-integration/en/guilin/docs_usecases.html#docs-usecases',
+   'https://docs.onap.org/projects/onap-integration/en/guilin/usecases/release_non_functional_requirements.html#release-non-functional-requirements',
+]
+
+
 html_last_updated_fmt = '%d-%b-%y %H:%M'
 
 def setup(app):
index 0aa0023..171d295 100644 (file)
@@ -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 3c93b29..6c8827d 100644 (file)
--- 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