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 <zxiiro@gmail.com>
Change-Id: I94d09ad6740efde204b4bb649623eedf346c3208

diff --git a/docs/conf.py b/docs/conf.py
index 925316abfa248333bf07605e24fc4a9ad928c78e..54994be301ec6204f845b7e4f71eee1b4978aeaa 100644 (file)
--- 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 39f992912c3469c850147f0a98a35a772154a693..64167d1684567a6bbd03e4dcb15b2c9d8358bb78 100644 (file)
--- 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 <https://wiki.opendaylight.org/view/OpenDaylight_Controller:MD-SAL:MD-SAL_App_Tutorial>`__
+    tutorial <https://wiki-archive.opendaylight.org/view/OpenDaylight_Controller:MD-SAL:MD-SAL_App_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 <https://wiki.opendaylight.org/view/OpenDaylight_Controller:MD-SAL:Startup_Project_Archetype>`__
+archetype <https://wiki-archive.opendaylight.org/view/OpenDaylight_Controller:MD-SAL:Startup_Project_Archetype>`__
 **and demonstrates how to:**
 
 -  preconfigure connectors to NETCONF devices
@@ -60,7 +60,7 @@ archetype <https://wiki.opendaylight.org/view/OpenDaylight_Controller:MD-SAL:Sta
 
 Detailed information about the structure of the application can be found
 at:
-https://wiki.opendaylight.org/view/Controller_Core_Functionality_Tutorials:Tutorials:Netconf_Mount
+https://wiki-archive.opendaylight.org/view/Controller_Core_Functionality_Tutorials:Tutorials:Netconf_Mount
 
 .. note::
 
@@ -235,4 +235,4 @@ returns it from ``showNode``.
 
     More information can be found in the source code of ncmount sample
     app + on wiki:
-    https://wiki.opendaylight.org/view/Controller_Core_Functionality_Tutorials:Tutorials:Netconf_Mount
+    https://wiki-archive.opendaylight.org/view/Controller_Core_Functionality_Tutorials:Tutorials:Netconf_Mount

diff --git a/docs/testtool.rst b/docs/testtool.rst
index 5cc4163bbf571526776845a66a2d2f13d73654e0..4327d978b2e83e6831d4c0677ab18fa5e1dd7153 100644 (file)
--- a/docs/testtool.rst
+++ b/docs/testtool.rst
@@ -64,7 +64,7 @@ Building testtool
 ^^^^^^^^^^^^^^^^^
 
 1. Check out latest NETCONF repository from
-   `git <https://git.opendaylight.org/gerrit/#/admin/projects/netconf>`__
+   `git <https://git.opendaylight.org/gerrit/admin/repos/netconf>`__
 
 2. Move into the ``opendaylight/netconf/tools/netconf-testtool/`` folder
 

diff --git a/tox.ini b/tox.ini
index 4f9c226fd158276651b4c84c74cb984c7fec61b3..ed92a278d66daa8e28eee54894ab9cb873626ef8 100644 (file)
--- 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