From a362cd25b5ed2098df75ceaf37a5eea6a1a32326 Mon Sep 17 00:00:00 2001 From: =?utf8?q?C=C3=A9dric=20Ollivier?= Date: Mon, 3 Jul 2023 11:20:40 +0200 Subject: [PATCH] Set Python and Ubuntu versions in .readthedocs.yaml MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit 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 Change-Id: I3290379450610652845d19d034f8ab61633c9baf --- .readthedocs.yaml | 12 +++++------- docs/conf.py | 4 +++- docs/installation.rst | 6 +----- docs/release-notes.rst | 6 +++--- docs/tox.ini | 23 +++++++++-------------- 5 files changed, 21 insertions(+), 30 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 3797dc8..f56b3b7 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -3,18 +3,16 @@ # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details # Required -version: 2 - -formats: - - htmlzip +version: 2 build: - image: latest + os: ubuntu-20.04 + tools: + python: "3.8" python: - version: 3.7 install: - - requirements: docs/requirements-docs.txt + - requirements: docs/requirements-docs.txt sphinx: configuration: docs/conf.py diff --git a/docs/conf.py b/docs/conf.py index 70937d7..fffe18d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -52,5 +52,7 @@ def setup(app): app.add_css_file("css/ribbon.css") linkcheck_ignore = [ - r'http://localhost:\d+/' + r'http://localhost:\d+/', + r'http://127.0.0.1/*', + r'https://msb_ip:*' ] \ No newline at end of file diff --git a/docs/installation.rst b/docs/installation.rst index ef73780..88349cc 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -16,11 +16,7 @@ OOM Charts The Modeling/etsicatalog K8S charts are located in the OOM repository: https://gerrit.onap.org/r/admin/repos/oom -For OOM deployment you can refer to the below links: - -* https://docs.onap.org/projects/onap-oom/en/latest/oom_user_guide.html#oom-user-guide - -* https://docs.onap.org/projects/onap-oom/en/latest/oom_quickstart_guide.html#oom-quickstart-guide +For OOM deployment please refer to the OOM documentation. Installing or Upgrading ------------------------ diff --git a/docs/release-notes.rst b/docs/release-notes.rst index e5a09de..7c6a0bf 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -11,7 +11,7 @@ etsicatalog provides package management service and parser service as Micro Service. Version: 1.0.14 --------------- +--------------- :Release Date: 2022-04-12 @@ -23,7 +23,7 @@ Released components: - etsicatalog 1.0.14 Version: 1.0.13 --------------- +--------------- :Release Date: 2022-03-30 @@ -38,7 +38,7 @@ Released components: Version: 1.0.11 --------------- +--------------- :Release Date: 2021-08-31 diff --git a/docs/tox.ini b/docs/tox.ini index 293b468..ce836cb 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,21 +8,18 @@ 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=master 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 + sphinx-build -W -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 -whitelist_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=master +commands = + sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck [testenv:docs-spellcheck] basepython = python3.8 @@ -32,5 +29,3 @@ deps = -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master commands = sphinx-build -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck - - -- 2.16.6