From 4d59d3530d1c41734f15423142e64eb9c929c717 Mon Sep 17 00:00:00 2001
From: Aric Gardner <agardner@linuxfoundation.org>
Date: Tue, 18 Sep 2018 11:05:14 -0400
Subject: Local Documentation Builds
This adds configuration for performing local documentation builds
with the following simple command:
tox -e docs
Change-Id: I84d69542d8c603e72d4af460834134d9711ac537
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
---
.gitignore | 2 ++
docs/conf.py | 1 +
docs/conf.yaml | 3 +++
docs/requirements.txt | 2 ++
tox.ini | 17 +++++++++++++++++
5 files changed, 25 insertions(+)
create mode 100644 .gitignore
create mode 100644 docs/conf.py
create mode 100644 docs/conf.yaml
create mode 100644 docs/requirements.txt
create mode 100644 tox.ini
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 00000000..71d7636c
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+.tox
+docs/_build/*
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 00000000..3c4453e7
--- /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 00000000..11787c9b
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,3 @@
+---
+project_cfg: opnfv
+project: SAMPLEVNF
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 00000000..9fde2df2
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,2 @@
+lfdocs-conf
+sphinx_opnfv_theme
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 00000000..69aa1893
--- /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
--
cgit