Add doc support and other CI related files
This change adds verious bits needed for CI and/or documentation
scraping as well as some README files.
The version in the CMake file was set to 0.1.0 in prep for activation
of CI jobs -- we want to be able to fiddle with those without actually
pushing a 1.x.x package to the repo. Once CI jobs are working we can
up the version to 1.0.0 to match the AP version.
Issue-ID: RIC-684
Signed-off-by: E. Scott Daniels <daniels@research.att.com>
Change-Id: Iac2c24a8e8f1c01af74e20c0bce9cad1c6bf6702
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 0000000..00d06df
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,34 @@
+# This work is licensed under a Creative Commons Attribution 4.0 International License.
+# SPDX-License-Identifier: CC-BY-4.0
+# Copyright (C) 2019 AT&T Intellectual Property
+# documentation only
+
+[tox]
+minversion = 2.0
+envlist =
+ docs,
+ docs-linkcheck,
+skipsdist = true
+
+[testenv:docs]
+basepython = python3
+deps =
+ sphinx
+ sphinx-rtd-theme
+ sphinxcontrib-httpdomain
+ recommonmark
+ lfdocs-conf
+
+commands =
+ sphinx-build -W -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]
+basepython = python3
+deps = sphinx
+ sphinx-rtd-theme
+ sphinxcontrib-httpdomain
+ recommonmark
+ lfdocs-conf
+commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck