Submodule Transition in IPv6 17/61917/3
authorBIN HU <bh526r@att.com>
Thu, 6 Sep 2018 16:40:26 +0000 (09:40 -0700)
committerBIN HU <bh526r@att.com>
Thu, 6 Sep 2018 17:53:00 +0000 (10:53 -0700)
Change-Id: Ida7c9b48d4cb947cbb54158ee238cb29c4be1430
Signed-off-by: BIN HU <bh526r@att.com>
docs/conf.py [new file with mode: 0644]
docs/conf.yaml [new file with mode: 0644]
docs/index.rst [new file with mode: 0644]
docs/requirements.txt [new file with mode: 0644]
tox.ini [new file with mode: 0644]

diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644 (file)
index 0000000..0cfa9d7
--- /dev/null
@@ -0,0 +1,9 @@
+#######################################################################
+# Copyright (c) 2018 AT&T
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+#######################################################################
+
+from docs_conf.conf import *
diff --git a/docs/conf.yaml b/docs/conf.yaml
new file mode 100644 (file)
index 0000000..38ea565
--- /dev/null
@@ -0,0 +1,3 @@
+---
+project_cfg: opnfv
+project: ipv6
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644 (file)
index 0000000..e89614b
--- /dev/null
@@ -0,0 +1,16 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Bin Hu (AT&T) and Sridhar Gaddam (RedHat)
+
+==================
+IPv6 Documentation
+==================
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   ./release/release-notes/index.rst
+   ./release/installation/index.rst
+   ./release/configguide/index.rst
+   ./release/userguide/index.rst
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644 (file)
index 0000000..29bb434
--- /dev/null
@@ -0,0 +1,6 @@
+lfdocs-conf
+sphinx_opnfv_theme
+
+# Uncomment the following line if your project uses Sphinx to document
+# HTTP APIs
+# sphinxcontrib-httpdomain
diff --git a/tox.ini b/tox.ini
new file mode 100644 (file)
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