summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorCédric Ollivier <cedric.ollivier@orange.com>2023-07-03 14:25:13 +0200
committerMatthew Watkins <mwatkins@linuxfoundation.org>2023-07-12 11:40:53 +0100
commit7a1feab696045222dba4f41d7a83edff85cdf230 (patch)
tree6bd5fef1217000ec14cac059d63377009801bd46 /docs
parent0d0a2ebd0bb4e0715072702d8f318b377295397a (diff)
Set Python and Ubuntu versions in .readthedocs.yamllondon
It now follows the ONAP gate configurations. It also fixes the settings and formats it. Issue-ID: DOC-811 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I806f6204f0f44d6f79ef4c1552c5659f0f59faf7 (cherry picked from commit 92c41700e45946a744dabb0530c12e2b82e4030c)
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py6
-rw-r--r--docs/tox.ini25
2 files changed, 14 insertions, 17 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 667f168..1a618df 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,6 +1,6 @@
roject = "onap"
-release = "master"
-version = "master"
+release = "london"
+version = "london"
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 = 'london'
intersphinx_mapping = {}
doc_url = 'https://docs.onap.org/projects'
diff --git a/docs/tox.ini b/docs/tox.ini
index 0341a88..4fca988 100644
--- a/docs/tox.ini
+++ b/docs/tox.ini
@@ -1,6 +1,6 @@
[tox]
minversion = 1.6
-envlist = docs,
+envlist = docs,docs-linkcheck,docs-spellcheck
skipsdist = true
[testenv:docs]
@@ -8,27 +8,24 @@ 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=london
commands =
- sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
- echo "Generated docs available in {toxinidir}/_build/html"
-allowlist_externals =
- echo
- git
- sh
+ 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
-commands = echo "Link Checking not enforced"
-#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck
-allowlist_externals = echo
+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=london
+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=master
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=london
commands =
- sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck
+ sphinx-build -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck