Docs transition

Changes are made by following
    https://docs.opnfv.org/en/latest/how-to-use-docs/local-build-transition.html

Change-Id: If0ee2031894d4dbd54098548640b8cc71481e49f
Signed-off-by: Fatih Degirmenci <fdegir@gmail.com>
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>

diff --git a/.gitignore b/.gitignore
index af9d008..925736c 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,6 @@
 *,~
 .*.sw?
-/docs_build/
+docs_build/*
 /docs_output/
 /releng/
 .idea
@@ -33,7 +33,7 @@ coverage.xml
 nosetests.xml
 testapi_venv/
 .cache
-.tox
+.tox/
 *.retry
 job_output/
 # Clear VM files
@@ -42,7 +42,7 @@ job_output/
 build.log
 *.d/
 _static/
-conf.py
 *.html
 html/
 xci/logs/
+docs/_build/*

diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644 (file)
index 0000000..86ab8c5
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1 @@
+from docs_conf.conf import *  # flake8: noqa

diff --git a/docs/conf.yaml b/docs/conf.yaml
new file mode 100644 (file)
index 0000000..305b679
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: opnfv
+project: releng-xci

diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644 (file)
index 0000000..f26b041
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,3 @@
+lfdocs-conf
+sphinxcontrib-httpdomain
+sphinx-opnfv-theme

diff --git a/tox.ini b/tox.ini
new file mode 100644 (file)
index 0000000..6aa1606
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,25 @@
+# Tox (http://tox.testrun.org/) is a tool for running tests
+# in multiple virtualenvs. This configuration file will run the
+# test suite on all supported python versions. To use it, "pip install tox"
+# and then run "tox" from this directory.
+
+[tox]
+envlist = docs,docs-linkcheck
+skipsdist = True
+
+[testenv]
+usedevelop = False
+setenv=
+  HOME = {envtmpdir}
+  PYTHONPATH = {toxinidir}
+
+[testenv:docs]
+deps = -r{toxinidir}/docs/requirements.txt
+commands =
+    sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs {toxinidir}/docs/_build/html
+    echo "Generated docs available in {toxinidir}/docs/_build/html"
+whitelist_externals = echo
+
+[testenv:docs-linkcheck]
+deps = -r{toxinidir}/docs/requirements.txt
+commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs {toxinidir}/docs/_build/linkcheck