Update docs to new format

Change-Id: I023b7f47245691fe7377e53ca0bda15098c2978a
Signed-off-by: Cristina Pauna <cristina.pauna@enea.com>

diff --git a/.gitignore b/.gitignore
index f6e7714..059072f 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -14,3 +14,5 @@
 **/mcp/scripts/virsh_net/*.xml
 **/mcp/scripts/docker-compose/*.yaml
 **/mcp/scripts/*.img
+.tox/
+docs/_build/*

diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644 (file)
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 (file)
index 0000000..bc1072b
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: opnfv
+project: fuel

diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644 (file)
index 0000000..744b47c
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,17 @@
+.. _fuel:
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Open Platform for NFV Project, Inc. and its contributors
+====
+FUEL
+====
+
+.. toctree::
+   :numbered:
+   :maxdepth: 2
+
+   release/release-notes/index
+   release/installation/index
+   release/userguide/index
+   scenarios/index

diff --git a/docs/release/scenarios/index.rst b/docs/release/scenarios/index.rst
new file mode 100644 (file)
index 0000000..f42c83b
--- /dev/null
+++ b/docs/release/scenarios/index.rst
@@ -0,0 +1,16 @@
+.. _fuel-scenarios:
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Open Platform for NFV Project, Inc. and its contributors
+
+*************************
+Scenarios for Fuel\@OPNFV
+*************************
+
+.. toctree::
+   :numbered:
+   :maxdepth: 2
+
+   os-nosdn-ovs-noha/index.rst
+   os-nosdn-ovs-ha/index.rst

diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644 (file)
index 0000000..4408435
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,5 @@
+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