From 3d9c200364c20d3d322bf64209fa1c4c1a7e46c8 Mon Sep 17 00:00:00 2001 From: "aravind.est" Date: Mon, 23 Oct 2023 13:46:39 +0100 Subject: [PATCH] Add requirements.txt file to have specific urllib urllib version updated to have specific version. Issue-ID: NONRTRIC-952 Signed-off-by: aravind.est Change-Id: Ibf4b137702c37216c5c92742fbf86de86c012c89 --- docs/requirements-docs.txt | 2 ++ tox.ini | 38 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 40 insertions(+) create mode 100755 docs/requirements-docs.txt create mode 100755 tox.ini diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt new file mode 100755 index 0000000..ba40ece --- /dev/null +++ b/docs/requirements-docs.txt @@ -0,0 +1,2 @@ +tox +urllib3~=1.26.15 \ No newline at end of file diff --git a/tox.ini b/tox.ini new file mode 100755 index 0000000..60e2f2c --- /dev/null +++ b/tox.ini @@ -0,0 +1,38 @@ +# ============LICENSE_START=============================================== +# Copyright (C) 2023 Nordix Foundation. All rights reserved. +# ======================================================================== +# 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. +# ============LICENSE_END================================================= +# + +# documentation only +[tox] +minversion = 2.0 +envlist = + docs, + docs-linkcheck, +skipsdist = true + +[testenv:docs] +basepython = python3 +deps = -r{toxinidir}/docs/requirements-docs.txt + +commands = + sphinx-build -W -b html -n -d {envtmpdir}/docs/doctrees ./docs/ {toxinidir}/docs/_build/html + echo "Generated docs available in {toxinidir}/docs/_build/html" +allowlist_externals = echo + +[testenv:docs-linkcheck] +basepython = python3 +deps = -r{toxinidir}/docs/requirements-docs.txt +commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck -- 2.16.6