From ee1cf739bd70134e5251ceaed4b48413a2d5e207 Mon Sep 17 00:00:00 2001 From: thmsdt Date: Tue, 4 Jul 2023 18:08:54 +0200 Subject: [PATCH] fix doc config files Issue-ID: DOC-811 Signed-off-by: thmsdt Change-Id: I06ff9a7b07f0e39976dc5868bfb9c971d1f22f5a --- .gitreview | 2 +- .readthedocs.yaml | 12 +++++------- docs/conf.py | 10 ++++++---- docs/installation.rst | 7 ++++--- docs/release-notes.rst | 8 ++++---- docs/spelling_wordlist.txt | 0 docs/tox.ini | 25 ++++++++++--------------- 7 files changed, 30 insertions(+), 34 deletions(-) create mode 100644 docs/spelling_wordlist.txt diff --git a/.gitreview b/.gitreview index e204ae0..7ec121a 100644 --- a/.gitreview +++ b/.gitreview @@ -2,4 +2,4 @@ host=gerrit.onap.org port=29418 project=modeling/etsicatalog -defaultbranch=master \ No newline at end of file +defaultbranch=london \ No newline at end of file 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..bddade5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,6 @@ project = "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' @@ -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..f8ba032 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -16,11 +16,12 @@ 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: +For OOM deployment you can refer to the OOM documentation. -* 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 +.. * 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 + Installing or Upgrading ------------------------ diff --git a/docs/release-notes.rst b/docs/release-notes.rst index e5a09de..d1afe14 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -5,13 +5,13 @@ Release Notes -============== +============= 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/spelling_wordlist.txt b/docs/spelling_wordlist.txt new file mode 100644 index 0000000..e69de29 diff --git a/docs/tox.ini b/docs/tox.ini index 293b468..aad283b 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,29 +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" -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=london +commands = + sphinx-build -W -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 -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck - - -- 2.16.6