summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--.gitignore2
-rw-r--r--INFO26
-rw-r--r--docs/conf.py1
-rw-r--r--docs/conf.yaml3
-rw-r--r--docs/requirements.txt2
-rw-r--r--tox.ini17
6 files changed, 25 insertions, 26 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..71d7636
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+.tox
+docs/_build/*
diff --git a/INFO b/INFO
deleted file mode 100644
index 4e2a911..0000000
--- a/INFO
+++ /dev/null
@@ -1,26 +0,0 @@
-Project: Network Readiness (NetReady)
-Project Creation Date: March 22, 2016
-Lifecycle State: Incubation
-Primary Contact: Georg Kunz
-Project Lead: Georg Kunz
-Jira Project Name: NetReady
-Jira Project Prefix: NETREADY
-Mailing list tag: [netready]
-IRC: Server:freenode.net Channel:#opnfv-netready
-Repository: netready
-
-Committers:
-Georg Kunz (Ericsson, georg.kunz@ericsson.com)
-Tim Irnich (Ericsson, tim.irnich@ericsson.com)
-Nikolas Hermanns (Ericsson, nikolas.hermanns@ericsson.com)
-Bin Hu (AT&T, bh526r@att.com)
-Prakash Ramchandran (Huawei, prakash.ramchandran@huawei.com)
-Juraj Linkes (Cisco, jlinkes@cisco.com)
-Viliam Luc -X (Cisco, vluc@cisco.com)
-Ahmed Elbornou (Cisco, amaged@cisco.com)
-Gergely Csatari (Nokia, gergely.csatari@nokia.com)
-
-
-Link to TSC approval of the project:
-http://ircbot.wl.linuxfoundation.org/meetings/opnfv-meeting/2016/opnfv-meeting.2016-03-22-14.00.html
-Link to nomination and acceptance of Daniel Smith as committer: http://lists.opnfv.org/pipermail/opnfv-tech-discuss/2016-May/010335.html
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..3c4453e
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1 @@
+from docs_conf.conf import *
diff --git a/docs/conf.yaml b/docs/conf.yaml
new file mode 100644
index 0000000..599b1d7
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: opnfv
+project: NETREADY
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 0000000..9fde2df
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,2 @@
+lfdocs-conf
+sphinx_opnfv_theme
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 0000000..69aa189
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,17 @@
+[tox]
+minversion = 1.6
+envlist =
+ docs,
+ docs-linkcheck
+skipsdist = true
+
+[testenv:docs]
+deps = -rdocs/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 = -rdocs/requirements.txt
+commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck