From: Thanh Ha Date: Fri, 10 Jul 2020 14:30:22 +0000 (-0400) Subject: Do not fail on warnings for docs-linkcheck X-Git-Tag: release/aluminium~22 X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=commitdiff_plain;h=8fb1b893dd661d5347211a744ce5ce8118517df1 Do not fail on warnings for docs-linkcheck This is a workaround due to sphinx-tabs being incompatible with the Sphinx linkchecker which throws a warning. We mainly use linkchecker to catch broken links so we don't really need to fail on warnings as the main "docs" builder will still fail for warning level issues so this is a reasonable workaround. This patch also fixes some current broken links in the docs, mainly wiki.odl to wiki-archive.odl as these docs have not been migrated to the new wiki as of yet. Signed-off-by: Thanh Ha Change-Id: I94d09ad6740efde204b4bb649623eedf346c3208 --- diff --git a/docs/conf.py b/docs/conf.py index 925316abfa..54994be301 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,3 +12,6 @@ from docs_conf.conf import * +linkcheck_ignore = [ + 'http://localhost', +] \ No newline at end of file diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 39f992912c..64167d1684 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -21,7 +21,7 @@ support notifications from mounted NETCONF devices.** It may also be useful to read the generic `OpenDaylight MD-SAL app development - tutorial `__ + tutorial `__ before diving into this chapter. This guide assumes awareness of basic OpenDaylight application development. @@ -37,10 +37,10 @@ repositories: or checked out from the official OpenDaylight repository: -- https://git.opendaylight.org/gerrit/#/admin/projects/coretutorials +- https://git.opendaylight.org/gerrit/admin/repos/coretutorials **The application was built using the** `project startup maven -archetype `__ +archetype `__ **and demonstrates how to:** - preconfigure connectors to NETCONF devices @@ -60,7 +60,7 @@ archetype `__ + `git `__ 2. Move into the ``opendaylight/netconf/tools/netconf-testtool/`` folder diff --git a/tox.ini b/tox.ini index 4f9c226fd1..ed92a278d6 100644 --- a/tox.ini +++ b/tox.ini @@ -14,5 +14,5 @@ commands = [testenv:docs-linkcheck] basepython = python3 deps = -rdocs/requirements.txt -commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck +commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck