summaryrefslogtreecommitdiffstats
path: root/docs/tox.ini
diff options
context:
space:
mode:
authorJessica Wagantall <jwagantall@linuxfoundation.org>2020-02-06 13:25:49 -0800
committerJessica Wagantall <jwagantall@linuxfoundation.org>2020-09-25 10:31:25 -0700
commit449c8be406c77e3a6e5b0f5975e1f1a1c1bbd578 (patch)
tree556a56577304e9797bb6cda19f26e6c4c63694ef /docs/tox.ini
parent23030fc618c3137b8f8a33a38661104ade6cd5bd (diff)
Add ccsdk-oran docs configuration
Example of how this changeset was created. includes link to documentation: https://gist.github.com/Aricg/bf95ef40c542ba211be8771e88e6f410 Merging this will create https://onap-ccsdk-oran.readthedocs.io Issue-ID: CIMAN-364 Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org> Change-Id: I509302cf10fd03d5be93d3f1a8dd5609602bc76b Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
Diffstat (limited to 'docs/tox.ini')
-rw-r--r--docs/tox.ini22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/tox.ini b/docs/tox.ini
new file mode 100644
index 00000000..edac8c35
--- /dev/null
+++ b/docs/tox.ini
@@ -0,0 +1,22 @@
+[tox]
+minversion = 1.6
+envlist = docs,
+skipsdist = true
+
+[testenv:docs]
+basepython = python3
+deps = -r{toxinidir}/requirements-docs.txt
+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