From: Thanh Ha <thanh.ha@linuxfoundation.org>
Date: Mon, 30 Apr 2018 13:23:58 +0000 (-0400)
Subject: Add docs env to tox
X-Git-Tag: release/fluorine~16
X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=commitdiff_plain;ds=sidebyside;h=10dccf35ee5b01800a8b3c59cb01d7c2d87ca530;p=integration%2Fdistribution.git

Add docs env to tox

Add docs and docs-linkcheck environments to build docs via tox.

Also adds missing favicon.ico.

Change-Id: I3b43689d3be952656baf87954adbb02d3f9c8145
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
---

diff --git a/.gitignore b/.gitignore
index d4c57ecd..a508c9ec 100644
--- a/.gitignore
+++ b/.gitignore
@@ -35,3 +35,4 @@ log.txt
 
 # Tox test/linting files
 .tox/
+_build/
diff --git a/docs/favicon.ico b/docs/favicon.ico
new file mode 100644
index 00000000..c9b3888c
Binary files /dev/null and b/docs/favicon.ico differ
diff --git a/tox.ini b/tox.ini
index 66896abc..c9747942 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,6 +1,10 @@
 [tox]
 minversion = 1.6.0
-envlist = pep8,coala
+envlist =
+    coala,
+    docs,
+    docs-linkcheck,
+    pep8
 skipsdist = true
 
 [testenv:coala]
@@ -14,6 +18,17 @@ commands =
     python3 -m nltk.downloader punkt maxent_treebank_pos_tagger averaged_perceptron_tagger
     coala --non-interactive
 
+[testenv:docs]
+deps = -rdocs/requirements.txt
+commands =
+    sphinx-build -W -b html -n -W -d {envtmpdir}/doctrees ./docs/ {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 -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
+
 [testenv:pep8]
 deps =
     flake8