diff options
| author |   Guillaume Lambert <guillaume.lambert@orange.com> | 2021-02-02 15:07:08 +0100 |
|---|---|---|
| committer | Guillaume Lambert <guillaume.lambert@orange.com> | 2021-02-15 14:51:14 +0100 |
| commit | 1b310c7db2993775d7c9f135f8b784d6260fbb90 (patch) | |
| tree | b9017c79c83a702b429a95b099f6d253e9bb8199 | |
| parent | ec1fb9229d6a505112677be97a8ea0c04cb7af16 (diff) | |
[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 <guillaume.lambert@orange.com>
Change-Id: I619d8d5697a35bf2bdf3ee2ed59ca9f5733e7802
(cherry picked from commit 5b9d80a4e9175cfd6bd7f2be33c540053f726005)
| -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 |