diff options
author | thmsdt <thomas.kulik@telekom.de> | 2021-11-03 15:29:49 +0100 |
---|---|---|
committer | thmsdt <thomas.kulik@telekom.de> | 2021-11-03 15:30:44 +0100 |
commit | e0bda53e0b9ce854748d2abb70b5b5435f035a9e (patch) | |
tree | c361e0f4442bcf17f0d21f90157fa44dfa2a49fa | |
parent | 927d2a872c7e7771b3be151ba9192bfbf0479df3 (diff) |
[DOC] Correct requirements for doc chain building
Issue-ID: DOC-765
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: Ibd983e4f8794c2e8c748d47911f4aa663ebc2459
-rw-r--r-- | .gitreview | 1 | ||||
-rw-r--r-- | docs/conf.py | 5 | ||||
-rw-r--r-- | docs/requirements-docs.txt | 12 | ||||
-rw-r--r-- | docs/tox.ini | 7 | ||||
-rw-r--r-- | tox.ini | 40 |
5 files changed, 26 insertions, 39 deletions
@@ -2,3 +2,4 @@ host=gerrit.onap.org port=29418 project=vnfrqts/guidelines.git +defaultbranch=istanbul diff --git a/docs/conf.py b/docs/conf.py index 5371015..1c42fea 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,6 @@ from docs_conf.conf import * -branch = 'latest' +branch = 'istanbul' master_doc = 'index' linkcheck_ignore = [ @@ -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 diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index b3188dd..d29d46c 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -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 diff --git a/docs/tox.ini b/docs/tox.ini index edac8c3..8b0a0fa 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -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?h=istanbul + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=istanbul 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 @@ -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?h=istanbul + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=istanbul 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
\ No newline at end of file |