summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAric Gardner <agardner@linuxfoundation.org>2018-09-18 11:04:52 -0400
committerAlexandru Avadanii <Alexandru.Avadanii@enea.com>2018-09-24 19:23:59 +0200
commitca6c6e7ef7c5fe463a8df66dcf741728b35dad62 (patch)
treec968062df2a02e0a0fa774b60ff978574487d376
parentaf1b29c7d9a02c35e10fd36d3c1fc88ba0192035 (diff)
Local Documentation Builds
This adds configuration for performing local documentation builds with the following simple command: tox -e docs Change-Id: Ib0d60d9f458b19dd5e77de962d34c1d299de7b16 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
-rw-r--r--.gitignore3
-rw-r--r--docs/conf.py8
-rw-r--r--docs/conf.yaml10
-rw-r--r--docs/requirements.txt9
-rw-r--r--tox.ini24
5 files changed, 52 insertions, 2 deletions
diff --git a/.gitignore b/.gitignore
index 1b73728..596f179 100644
--- a/.gitignore
+++ b/.gitignore
@@ -47,7 +47,7 @@ coverage.xml
*.log
# Sphinx documentation
-docs/_build/
+docs/_build/*
# PyBuilder
target/
@@ -58,7 +58,6 @@ target/
*~
.*.sw?
-/docs_build/
/docs_output/
/releng/
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..f0c2a78
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,8 @@
+##############################################################################
+# Copyright (c) 2018 Linux Foundation 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 * # noqa: F401,F403
diff --git a/docs/conf.yaml b/docs/conf.yaml
new file mode 100644
index 0000000..b3782ee
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,10 @@
+##############################################################################
+# Copyright (c) 2018 Linux Foundation 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: PHAROS
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 0000000..0045076
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,9 @@
+##############################################################################
+# Copyright (c) 2018 Linux Foundation 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
index 0000000..8898266
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,24 @@
+##############################################################################
+# Copyright (c) 2018 Linux Foundation 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
+ 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