Switch promise from submodules to intersphinx 11/61911/1
authorBertrand Souville <souville@docomolab-euro.com>
Thu, 6 Sep 2018 15:00:13 +0000 (17:00 +0200)
committerBertrand Souville <souville@docomolab-euro.com>
Thu, 6 Sep 2018 15:00:13 +0000 (17:00 +0200)
Change-Id: I8feb0ba713e26fb112b32032703a7b1aeb75fc88
Signed-off-by: Bertrand Souville <souville@docomolab-euro.com>
.gitignore
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]

index 33a0451..e8a1a6f 100644 (file)
@@ -3,3 +3,6 @@
 /docs_build/
 /docs_output/
 /releng/
+
+.tox/
+docs/_build/*
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644 (file)
index 0000000..3c4453e
--- /dev/null
@@ -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..ebfb56e
--- /dev/null
@@ -0,0 +1,3 @@
+---
+project_cfg: opnfv
+project: Promise
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644 (file)
index 0000000..159c048
--- /dev/null
@@ -0,0 +1,16 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. (c) Open Platform for NFV Project, Inc. and its contributors
+
+.. _promise:
+
+=======
+Promise
+=======
+
+.. toctree::
+   :numbered:
+   :maxdepth: 2
+
+   release/release-notes/index
+   development/requirements/index
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644 (file)
index 0000000..9fde2df
--- /dev/null
@@ -0,0 +1,2 @@
+lfdocs-conf
+sphinx_opnfv_theme
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