summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCristina Pauna <cristina.pauna@enea.com>2018-09-06 09:01:30 +0300
committerCristina Pauna <cristina.pauna@enea.com>2018-09-06 09:51:51 +0300
commit78fc284540fd60a3bdc77d7ec180d75a0a0a26ca (patch)
tree800fc139b9434871b9475c0402ddc66eeb266fbc
parent7365eeeb18265d02f874161f2406166280edf7b3 (diff)
Update docs to new format
Change-Id: I023b7f47245691fe7377e53ca0bda15098c2978a Signed-off-by: Cristina Pauna <cristina.pauna@enea.com>
-rw-r--r--.gitignore2
-rw-r--r--docs/conf.py1
-rw-r--r--docs/conf.yaml3
-rw-r--r--docs/index.rst17
-rw-r--r--docs/release/scenarios/index.rst16
-rw-r--r--docs/requirements.txt5
-rw-r--r--tox.ini17
7 files changed, 61 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
index f6e77140a..059072f14 100644
--- 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
index 000000000..3c4453e71
--- /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 000000000..bc1072bb5
--- /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
index 000000000..744b47cee
--- /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
index 000000000..f42c83b6f
--- /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
index 000000000..440843584
--- /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
index 000000000..69aa18937
--- /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