aboutsummaryrefslogtreecommitdiffstats
path: root/tox.ini
diff options
context:
space:
mode:
authorlukegleeson <luke.gleeson@est.tech>2021-10-15 15:26:19 +0100
committerlukegleeson <luke.gleeson@est.tech>2021-10-15 15:26:19 +0100
commit0602329589d081ea0cc46fe91186ba29f2d38274 (patch)
tree7799723ec35bf60bd03229b433a5c10497954404 /tox.ini
parent3ab5f02443279f543947b90e44e7d48193033524 (diff)
DOC Bug Fixes
Cherry-picked fixes: https://gerrit.onap.org/r/c/cps/cps-temporal/+/125040 https://gerrit.onap.org/r/c/cps/cps-temporal/+/125041 Signed-off-by: lukegleeson <luke.gleeson@est.tech> Rename /docs/requirements-docs.txt to requirements.txt It's asked by rtd. Issue-ID: DOC-765 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I08256620f36f01afd202b5a4d7092983e101905e (cherry picked from commit 508a72aef6d0ec9790480a8ba96ebf44785aaf97) Add missing RTD static files Clean up conf.py based on advice from docs team Issue-ID: DOC-765 Signed-off-by: ToineSiebelink <toine.siebelink@est.tech> Change-Id: I48c9f6cd60cd9f7142081fff649da01d48868b57 (cherry picked from commit 6833edbf4624914419c4af24b31c2452470ec83c) Signed-off-by: lukegleeson <luke.gleeson@est.tech>
Diffstat (limited to 'tox.ini')
-rw-r--r--tox.ini44
1 files changed, 44 insertions, 0 deletions
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 0000000..92aa4b2
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,44 @@
+# ============LICENSE_START=======================================================
+# Copyright (C) 2021 Bell Canada
+# ================================================================================
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# ============LICENSE_END=========================================================
+
+[tox]
+minversion = 1.6
+envlist = docs
+skipsdist = true
+
+[testenv:docs]
+basepython = python3
+deps = -r{toxinidir}/requirements.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
+commands =
+ sphinx-build -b html -n -d {envtmpdir}/docs/doctrees ./docs {toxinidir}/docs/_build/html
+ echo "Generated docs available in {toxinidir}/docs/_build/html"
+whitelist_externals =
+ echo
+ git
+ sh
+
+[testenv:docs-linkcheck]
+basepython = python3
+deps = -r{toxinidir}/requirements.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
+commands = echo "Link Checking not enforced"
+whitelist_externals =
+ echo