summaryrefslogtreecommitdiffstats
path: root/examples/sphinx/tox.ini_MASTER
diff options
context:
space:
mode:
authorthmsdt <thomas.kulik@telekom.de>2021-10-19 12:05:48 +0200
committerthmsdt <thomas.kulik@telekom.de>2021-11-17 10:33:17 +0100
commitd6b7f66b0d3cbc4e7c92a85837a8e74906c08434 (patch)
treeaf702ffc4e707f71c72f0368e2abc40fe97ab6cf /examples/sphinx/tox.ini_MASTER
parenteb3b0515916012651dc8f4fb8c432da13759ec56 (diff)
Add sphinx example configuration files
Issue-ID: DOC-772 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I2cb913388cb1db28400de12d31fc74776627e9e8
Diffstat (limited to 'examples/sphinx/tox.ini_MASTER')
-rw-r--r--examples/sphinx/tox.ini_MASTER25
1 files changed, 25 insertions, 0 deletions
diff --git a/examples/sphinx/tox.ini_MASTER b/examples/sphinx/tox.ini_MASTER
new file mode 100644
index 000000000..c5ed11775
--- /dev/null
+++ b/examples/sphinx/tox.ini_MASTER
@@ -0,0 +1,25 @@
+[tox]
+minversion = 1.6
+envlist = docs,
+skipsdist = true
+
+[testenv:docs]
+basepython = python3
+deps =
+ -r{toxinidir}/requirements-docs.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt?h=master
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
+commands =
+ sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
+ echo "Generated docs available in {toxinidir}/_build/html"
+whitelist_externals =
+ echo
+ git
+ sh
+
+[testenv:docs-linkcheck]
+basepython = python3
+#deps = -r{toxinidir}/requirements-docs.txt
+commands = echo "Link Checking not enforced"
+#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck
+whitelist_externals = echo \ No newline at end of file