Merge "Upgrade E2Mgr spec to version 2.0.5 of 2019-09-11"

diff --git a/.gitignore b/.gitignore
index ecc268e..2bfa4fa 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -47,3 +47,6 @@
 
 # OSx cruft
 **/.DS_Store
+
+# documentation
+.tox

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644 (file)
index 0000000..7496bc4
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,12 @@
+---
+# pip requirements file for building sphinx docs (e.g. nbsphinx)
+version: 2
+
+sphinx:
+    configuration: docs/conf.py
+
+# Use python 3 for building
+python:
+    version: 3.6
+    install:
+        - requirements: docs/requirements-docs.txt

diff --git a/docs/.gitignore b/docs/.gitignore
index f6b991e..173f8dc 100644 (file)
--- a/docs/.gitignore
+++ b/docs/.gitignore
@@ -1,3 +1,3 @@
-/conf.py
+/_build
 /out
 /_build

diff --git a/docs/_static/logo.png b/docs/_static/logo.png
new file mode 100644 (file)
index 0000000..c3b6ce5
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 (file)
index 0000000..592a573
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,2 @@
+from docs_conf import *
+master_doc = 'index'

diff --git a/docs/conf.yaml b/docs/conf.yaml
new file mode 100644 (file)
index 0000000..02f362d
--- /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 (file)
index 0000000..00b0fd0
Binary files /dev/null and b/docs/favicon.ico differ

diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
new file mode 100644 (file)
index 0000000..09a0c1c
--- /dev/null
+++ b/docs/requirements-docs.txt
@@ -0,0 +1,5 @@
+sphinx
+sphinx-rtd-theme
+sphinxcontrib-httpdomain
+recommonmark
+lfdocs-conf

diff --git a/tox.ini b/tox.ini
new file mode 100644 (file)
index 0000000..96d6ff8
--- /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