From ca6c6e7ef7c5fe463a8df66dcf741728b35dad62 Mon Sep 17 00:00:00 2001 From: Aric Gardner Date: Tue, 18 Sep 2018 11:04:52 -0400 Subject: 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 --- tox.ini | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 tox.ini (limited to 'tox.ini') diff --git a/tox.ini b/tox.ini new file mode 100644 index 00000000..8898266c --- /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 -- cgit 1.2.3-korg