From 7a75926bf9f4a65dc469a48833d41e79c46dd4e9 Mon Sep 17 00:00:00 2001 From: thmsdt Date: Fri, 5 Jan 2024 13:36:06 +0100 Subject: fix docs config files Issue-ID: DOC-821 Change-Id: I68befe46955e8192d834e0f5eaf9c0daa4ecba7f Signed-off-by: thmsdt --- .gitreview | 2 +- docs/conf.py | 6 +++--- docs/tox.ini | 48 ++++++++++++++++++++---------------------------- 3 files changed, 24 insertions(+), 32 deletions(-) diff --git a/.gitreview b/.gitreview index 26d196b4..adf5dc14 100644 --- a/.gitreview +++ b/.gitreview @@ -2,4 +2,4 @@ host=gerrit.onap.org port=29418 project=multicloud/k8s.git -defaultbranch=master +defaultbranch=montreal diff --git a/docs/conf.py b/docs/conf.py index a9c42b67..4b5c7037 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,6 @@ project = "onap" -release = "master" -version = "master" +release = "montreal" +version = "montreal" author = "Open Network Automation Platform" # yamllint disable-line rule:line-length @@ -30,7 +30,7 @@ extensions = [ # Change to {releasename} after you have created the new 'doc' branch. # -branch = 'latest' +branch = 'montreal' intersphinx_mapping = {} doc_url = 'https://docs.onap.org/projects' diff --git a/docs/tox.ini b/docs/tox.ini index ddafc780..98f0efcb 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -1,37 +1,29 @@ [tox] minversion = 1.6 -envlist = docs, +envlist = docs,docs-linkcheck,docs-spellcheck skipsdist = true - [testenv:docs] basepython = python3.8 deps = -r{toxinidir}/requirements-docs.txt -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt - -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=montreal 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.8 -#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 - -[testenv:docs-spellcheck] -basepython = python3.8 -deps = - -r{toxinidir}/requirements-docs.txt - -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt - -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master -commands = - sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck - - - + sphinx-build -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html +#[testenv:docs-linkcheck] +#basepython = python3.8 +#deps = +# -r{toxinidir}/requirements-docs.txt +# -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt +# -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=montreal +#commands = +# sphinx-build -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck +# +#[testenv:docs-spellcheck] +#basepython = python3.8 +#deps = +# -r{toxinidir}/requirements-docs.txt +# -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt +# -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=montreal +#commands = +# sphinx-build -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck \ No newline at end of file -- cgit 1.2.3-korg