Armband: All local documentation builds

Change-Id: I76b42e26375c81e9090d9d034b834f0f5b1d8506
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>

diff --git a/.gitignore b/.gitignore
index 3fcc626..f4f687f 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -3,3 +3,5 @@ build.log
 config.mk
 ci/clean_cache.sh
 *.sw?
+.tox/
+docs/_build/*

diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644 (file)
index 0000000..c175a6c
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,15 @@
+##############################################################################
+# Copyright (c) 2018 Enea AB and others.
+# 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 *
+
+extensions = ['sphinxcontrib.httpdomain', 'sphinx.ext.autodoc',
+              'sphinx.ext.viewcode', 'sphinx.ext.napoleon',
+              'sphinx.ext.intersphinx']
+
+intersphinx_mapping = {}
+intersphinx_mapping['armband'] = ('https://opnfv-armband.readthedocs.io/en/latest/', None)

diff --git a/docs/conf.yaml b/docs/conf.yaml
new file mode 100644 (file)
index 0000000..68e42df
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,10 @@
+##############################################################################
+# Copyright (c) 2018 Enea AB and others.
+# 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
+##############################################################################
+---
+project_cfg: opnfv
+project: armband

diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644 (file)
index 0000000..e1eb3ad
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,17 @@
+.. 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
+
+.. _armband:
+
+=======
+Armband
+=======
+
+.. toctree::
+   :maxdepth: 2
+
+   release/installation/index
+   release/release-notes/index
+   release/userguide/index

diff --git a/docs/release/userguide/userguide.rst b/docs/release/userguide/userguide.rst
index 80d05d1..546d9a0 100644 (file)
--- a/docs/release/userguide/userguide.rst
+++ b/docs/release/userguide/userguide.rst
@@ -1,5 +1,6 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
+.. 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
 
 ========
@@ -13,6 +14,6 @@ standard release OPNFV, such that the release can be available on both
 Intel Architecture-based and ARM Architecture-based servers.
 
 The armband repo contains the patches necessary for Fuel installer to run on
-aarch64 hardware. For more information on how to use Fuel@OPNFV - Fraser
+aarch64 hardware. For more information on how to use Fuel\@OPNFV - Fraser
 release - after it was deployed check
 :ref:`fuel-release-userguide-label`

diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644 (file)
index 0000000..87ba3aa
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,9 @@
+##############################################################################
+# Copyright (c) 2018 Enea AB and others.
+# 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
+##############################################################################
+lfdocs-conf
+sphinx_opnfv_theme

diff --git a/tox.ini b/tox.ini
new file mode 100644 (file)
index 0000000..c3299e4
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,22 @@
+##############################################################################
+# Copyright (c) 2018 Enea AB and others.
+# 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
+##############################################################################
+[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
+
+[testenv:docs-linkcheck]
+deps = -rdocs/requirements.txt
+commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck