[DOC] Correct requirements for doc chain building 67/125567/1
authorthmsdt <thomas.kulik@telekom.de>
Wed, 3 Nov 2021 14:24:08 +0000 (15:24 +0100)
committerthmsdt <thomas.kulik@telekom.de>
Wed, 3 Nov 2021 14:24:57 +0000 (15:24 +0100)
Issue-ID: DOC-765

Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: I6c8da66146fa950f0aa2991cf386a940dd9e53e9

docs/conf.py
docs/requirements-docs.txt
docs/tox.ini
tox.ini

index 5371015..36002aa 100644 (file)
@@ -11,5 +11,6 @@ intersphinx_mapping = {}
 
 html_last_updated_fmt = '%d-%b-%y %H:%M'
 
+
 def setup(app):
-    app.add_stylesheet("css/ribbon.css")
+    app.add_css_file("css/ribbon.css")
\ No newline at end of file
index b3188dd..d29d46c 100644 (file)
@@ -1,15 +1,3 @@
-tox
-Sphinx
-doc8
-docutils
 setuptools
 six
-sphinx_rtd_theme>=0.4.3
-sphinxcontrib-blockdiag
-sphinxcontrib-needs>=0.2.3
-sphinxcontrib-nwdiag
-sphinxcontrib-seqdiag
-sphinxcontrib-swaggerdoc
-sphinxcontrib-plantuml
-sphinx_bootstrap_theme
 lfdocs-conf
index edac8c3..fcd5d7d 100644 (file)
@@ -5,7 +5,10 @@ skipsdist = true
 
 [testenv:docs]
 basepython = python3
-deps = -r{toxinidir}/requirements-docs.txt
+deps =
+    -r{toxinidir}/requirements-docs.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}/doctrees ./ {toxinidir}/_build/html
     echo "Generated docs available in {toxinidir}/_build/html"
@@ -19,4 +22,4 @@ 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
+whitelist_externals = echo
\ No newline at end of file
diff --git a/tox.ini b/tox.ini
index 33fde8e..42ffa68 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -1,31 +1,25 @@
-##############################################################################
-# Copyright (C) 2017 AT&T Intellectual Property. 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.
-#############################################################################
-
 [tox]
 minversion = 1.6
-envlist = docs,docs-linkcheck
+envlist = docs,
 skipsdist = true
 
 [testenv:docs]
-deps = -r{toxinidir}/etc/requirements.txt
+basepython = python3
+deps =
+    -r{toxinidir}/requirements-docs.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}/doctrees ./docs/ {toxinidir}/docs/_build/html
-    echo "Generated docs available in {toxinidir}/docs/_build/html"
-whitelist_externals = echo
+    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]
-deps = -r{toxinidir}/etc/requirements.txt
-commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/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