[FAB-11180] Adding docs-link to tox.ini

This is required in order for tox to check
for broken links.

Change-Id: I88b3acb501f94513240ef66a02f279a8458fb74c
Signed-off-by: Jason Clark <jtclark@linux.vnet.ibm.com>

docs/source/conf.py

@@ -197,7 +197,8 @@ def setup(app):
 # A list of files that should not be packed into the epub file.
 epub_exclude_files = ['search.html']
 
-
-
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'https://docs.python.org/': None}
+
+# Skip the links with anchor tags during the linkcheck
+linkcheck_anchors = False

tox.ini

@@ -1,6 +1,8 @@
 [tox]
 minversion = 1.6
-envlist = docs
+envlist =
+    docs,
+    docs-linkcheck
 skipsdist=true
 
 [testenv:docs]
@@ -9,3 +11,8 @@ commands =
     sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/source {toxinidir}/docs/_build/html
     echo "Generated docs available in {toxinidir}/docs/_build/html"
 whitelist_externals = echo
+
+[testenv:docs-linkcheck]
+deps = -rdocs/requirements.txt
+commands =
+    sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/source {toxinidir}/docs/_build/linkcheck