From 48f63ef8e43f789cc6d364d387df289094edfc25 Mon Sep 17 00:00:00 2001 From: Marek Szwałkiewicz Date: Thu, 13 Jul 2023 12:21:23 +0200 Subject: Add .readthedocs.yaml and fix the lingering errors MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This commit started as plain adding of .readthedocs file but to allow tests to pass we needed to perform some doc/docstring fixes. Issue-ID: INT-2260 Change-Id: Ib603b9aaad43bb8c55ff5c2c23cd9a1a29865de9 Signed-off-by: Marek Szwałkiewicz --- .readthedocs.yaml | 3 +-- README.md | 2 +- docs/conf.py | 4 ++-- docs/development.rst | 2 +- docs/tox.ini | 12 ++++++------ docs/usage/usage/cds.rst | 8 ++++---- docs/usage/usage/cps.rst | 2 +- docs/usage/usage/dmaap.rst | 6 +++--- docs/usage/usage/instantiation.rst | 10 +++++----- docs/usage/usage/ves.rst | 2 +- src/onapsdk/cds/data_dictionary.py | 21 ++++++++++++--------- src/onapsdk/sdc/service.py | 4 ++-- src/onapsdk/sdc/vf.py | 2 +- 13 files changed, 40 insertions(+), 38 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 09c9138..f56b3b7 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -12,8 +12,7 @@ build: python: install: - - requirements: docs/requirements-docs.txt + - requirements: docs/requirements-docs.txt sphinx: configuration: docs/conf.py - diff --git a/README.md b/README.md index 0eb8fd8..20c2f94 100644 --- a/README.md +++ b/README.md @@ -108,7 +108,7 @@ $ docker-compose up ``` Please note that *docker-compose* attempts to create subnet 172.20.0.0/24, so it can not be run if the scope is already allocated. Also, containers are not reachable by their IP addresses on Windows host since -Docker for Windows [does not support](https://docs.docker.com/docker-for-windows/networking/#known-limitations-use-cases-and-workarounds) +Docker for Windows [does not support](https://docs.docker.com/desktop/networking/#known-limitations-for-all-platforms) bridged network interface for Linux containers. Once containers are running, execute the following in the project's directory: diff --git a/docs/conf.py b/docs/conf.py index 536f6f9..ab8d09e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -13,7 +13,7 @@ # import os import sys -sys.path.insert(0, os.path.abspath('../src/onapsdk')) +sys.path.insert(0, os.path.abspath('../src')) # -- Project information ----------------------------------------------------- @@ -58,7 +58,7 @@ templates_path = ['_templates'] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.tox'] # -- Options for HTML output ------------------------------------------------- diff --git a/docs/development.rst b/docs/development.rst index d1029b3..107970d 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -111,7 +111,7 @@ Also, containers are not reachable by their IP addresses on Windows host since Docker for Windows does not support bridged network interface for Linux containers. For reference, please see Docker docs_. -.. _docs: https://docs.docker.com/docker-for-windows/networking/#known-limitations-use-cases-and-workarounds +.. _docs: https://docs.docker.com/desktop/networking/#known-limitations-for-all-platforms Once containers are running, execute the following in the project's directory: diff --git a/docs/tox.ini b/docs/tox.ini index b9d7eb4..57ae89a 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -7,25 +7,25 @@ skipsdist = true basepython = python3.8 deps = -r{toxinidir}/requirements-docs.txt - -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt + -r{toxinidir}/../requirements.txt -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master commands = - sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html + 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 + -r{toxinidir}/../requirements.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 + 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 + -r{toxinidir}/../requirements.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 spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck diff --git a/docs/usage/usage/cds.rst b/docs/usage/usage/cds.rst index b516c73..6128e60 100644 --- a/docs/usage/usage/cds.rst +++ b/docs/usage/usage/cds.rst @@ -127,7 +127,7 @@ Upload data dictionary set dd_set.upload() Retrieve Blueprint Models from CDS --------------------------- +---------------------------------- #. All @@ -149,14 +149,14 @@ Retrieve Blueprint Models from CDS blueprint_model = BlueprintModel.get_by_name_and_version(blueprint_name='test_name', blueprint_version='1.0.0') Delete Blueprint Model --------------------------- +---------------------- .. code:: Python blueprint_model.delete() Download Blueprint Model --------------------------- +------------------------ .. code:: Python @@ -164,7 +164,7 @@ Download Blueprint Model Get Blueprint object for Blueprint Model --------------------------- +---------------------------------------- After that, all operation for blueprint object, like execute blueprint workflow etc. can be executed. diff --git a/docs/usage/usage/cps.rst b/docs/usage/usage/cps.rst index 0a19b29..3124bcf 100644 --- a/docs/usage/usage/cps.rst +++ b/docs/usage/usage/cps.rst @@ -11,7 +11,7 @@ Create dataspace Create schema set ----------------- +----------------- .. code:: Python diff --git a/docs/usage/usage/dmaap.rst b/docs/usage/usage/dmaap.rst index ee62d04..2154bf4 100644 --- a/docs/usage/usage/dmaap.rst +++ b/docs/usage/usage/dmaap.rst @@ -2,7 +2,7 @@ VES ### Preparation for DMAAP tests -------------------------- +--------------------------- #. Check existing DMaap Services: @@ -15,7 +15,7 @@ Preparation for DMAAP tests Remove all events from DMaap ---------------------------- +---------------------------- .. code:: Python @@ -31,7 +31,7 @@ Get all events from DMaap response = Dmaap.get_all_events() Get events from specific topic from DMaap -------------------------- +----------------------------------------- .. code:: Python diff --git a/docs/usage/usage/instantiation.rst b/docs/usage/usage/instantiation.rst index 642439e..dac0500 100644 --- a/docs/usage/usage/instantiation.rst +++ b/docs/usage/usage/instantiation.rst @@ -274,7 +274,7 @@ To provide more control on the SO macro instantiation, you can define your servi Instantiate VNF (Macro) ---------------- +----------------------- Since ONAP Istanbul the creation or deletion of VNFs in macro mode is supported. Examples below: @@ -334,7 +334,7 @@ Since ONAP Istanbul the creation or deletion of VNFs in macro mode is supported. Instantiate VNF using SO service template (Macro) ---------------- +------------------------------------------------- To provide more control on the SO macro instantiation for new vnf, you can define your vnf as follows: @@ -398,7 +398,7 @@ To provide more control on the SO macro instantiation for new vnf, you can defin Instantiate VNF (ALaCarte) ---------------- +-------------------------- .. code:: Python @@ -423,7 +423,7 @@ Instantiate VNF (ALaCarte) print("Instantiation failed, check logs") Instantiate Vf module (ALaCarte) ---------------------- +-------------------------------- .. code:: Python @@ -448,7 +448,7 @@ Instantiate Vf module (ALaCarte) print("Instantiation failed, check logs") Instantiate Vl module (ALaCarte) ---------------------- +-------------------------------- .. code:: Python diff --git a/docs/usage/usage/ves.rst b/docs/usage/usage/ves.rst index 4712d8b..8171a7d 100644 --- a/docs/usage/usage/ves.rst +++ b/docs/usage/usage/ves.rst @@ -30,7 +30,7 @@ Send event to Ves Collector ) Send event batch to Ves Collector -------------------------- +--------------------------------- .. code:: Python diff --git a/src/onapsdk/cds/data_dictionary.py b/src/onapsdk/cds/data_dictionary.py index b4d8d0e..27cfc29 100644 --- a/src/onapsdk/cds/data_dictionary.py +++ b/src/onapsdk/cds/data_dictionary.py @@ -136,6 +136,7 @@ class DataDictionary(CdsElement): - "entry_schema" - "updatedBy" - "definition" + "definition" key value should contains the "raw" data dictionary. Returns: @@ -153,15 +154,17 @@ class DataDictionary(CdsElement): this kind of data dictionary can't be uploaded to blueprintprocessor. That method tries to fix it. It can be done only if "raw" data dictionary has a given schema: - { - "name": "string", - "tags": "string", - "updated-by": "string", - "property": { - "description": "string", - "type": "string" - } - } + + .. code-block: json: + { + "name": "string", + "tags": "string", + "updated-by": "string", + "property": { + "description": "string", + "type": "string" + } + } Raises: ValidationError: Data dictionary doesn't have all required keys diff --git a/src/onapsdk/sdc/service.py b/src/onapsdk/sdc/service.py index 44a26e8..507b068 100644 --- a/src/onapsdk/sdc/service.py +++ b/src/onapsdk/sdc/service.py @@ -406,8 +406,8 @@ class Service(SdcResource): # pylint: disable=too-many-instance-attributes, too Load VNFs from components generator. It creates a generator of the vf modules as well, but without - vf modules which has "vf_module_label" property value equal - to "base_template_dummy_ignore". + vf modules which has "vf_module_label" property value equal + to "base_template_dummy_ignore". Returns: Iterator[Vnf]: Vnf objects iterator diff --git a/src/onapsdk/sdc/vf.py b/src/onapsdk/sdc/vf.py index 7e4e4a7..3b979b5 100644 --- a/src/onapsdk/sdc/vf.py +++ b/src/onapsdk/sdc/vf.py @@ -72,7 +72,7 @@ class Vf(SdcResource): If Vf is created vendor is get from it's resource metadata. Otherwise it's vendor provided by the user or the vendor from vsp. It's possible that method returns None, but it won't be possible then - to create that Vf resource. + to create that Vf resource. Returns: Optional[Vendor]: Vendor object related with Vf -- cgit 1.2.3-korg