From: Lott, Christopher (cl778h) <cl778h@att.com>
Date: Wed, 4 Sep 2019 18:26:33 +0000 (-0400)
Subject: Add python/tox config for documentation
X-Git-Tag: R2~27
X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=3abfae99a3ce81eb237cd8c0cdf8d524a659aa68;p=portal%2Fric-dashboard.git

Add python/tox config for documentation

Change-Id: I755b1fbce971d0df5fb4d4508ae3beb5f6a286b2
Signed-off-by: Lott, Christopher (cl778h) <cl778h@att.com>
---

diff --git a/.gitignore b/.gitignore
index 175c3801..27ad92d8 100644
--- a/.gitignore
+++ b/.gitignore
@@ -46,3 +46,6 @@
 
 # OSx cruft
 **/.DS_Store
+
+# documentation
+.tox
diff --git a/docs/.gitignore b/docs/.gitignore
index 651cf82b..89d07656 100644
--- a/docs/.gitignore
+++ b/docs/.gitignore
@@ -1,2 +1,2 @@
-/conf.py
+/_build
 /out
diff --git a/docs/_static/logo.png b/docs/_static/logo.png
new file mode 100644
index 00000000..c3b6ce56
Binary files /dev/null and b/docs/_static/logo.png differ
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 00000000..4651a2b8
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1 @@
+from docs_conf import *
diff --git a/docs/conf.yaml b/docs/conf.yaml
new file mode 100644
index 00000000..02f362de
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: lfdocs
+project: portal-ric-dashboard
diff --git a/docs/favicon.ico b/docs/favicon.ico
new file mode 100644
index 00000000..00b0fd0e
Binary files /dev/null and b/docs/favicon.ico differ
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 00000000..96d6ff8e
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,26 @@
+# 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
+commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck