diff options
| author |   Andreas Geissler <andreas-geissler@telekom.de> | 2021-02-18 16:11:49 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@onap.org> | 2021-02-18 16:11:49 +0000 |
| commit | fd1984ad3ff36c850103a5303e85fb5a17e577ae (patch) | |
| tree | c69c0258f08417ce0ea12026289b3d005c057178 | |
| parent | 48a3c73817102570b5fb1bd90a1f205767672666 (diff) | |
| parent | 1b310c7db2993775d7c9f135f8b784d6260fbb90 (diff) | |
Merge "[DOC] Fix tox docs-linkcheck profile issues" into guilin
| -rw-r--r-- | docs/conf.py | 14 | ||||
| -rw-r--r-- | docs/guides/onap-user/vfw-design-tutorial/index.rst | 8 | ||||
| -rw-r--r-- | tox.ini | 2 |
3 files changed, 21 insertions, 3 deletions
diff --git a/docs/conf.py b/docs/conf.py index cdca70464..4dfc64ece 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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): 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) @@ -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 |