aboutsummaryrefslogtreecommitdiffstats
path: root/docs/usage
diff options
context:
space:
mode:
authorMarek Szwałkiewicz <marek.szwalkiewicz@external.t-mobile.pl>2023-07-13 12:21:23 +0200
committerMarek Szwałkiewicz <marek.szwalkiewicz@external.t-mobile.pl>2023-07-24 15:42:55 +0200
commit48f63ef8e43f789cc6d364d387df289094edfc25 (patch)
tree7865d2785406d06559a3978da42d1107c4c11e96 /docs/usage
parentd39c14ca0b8ba9e187c7c9b27793a737e90c3337 (diff)
Add .readthedocs.yaml and fix the lingering errors
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 <marek.szwalkiewicz@external.t-mobile.pl>
Diffstat (limited to 'docs/usage')
-rw-r--r--docs/usage/usage/cds.rst8
-rw-r--r--docs/usage/usage/cps.rst2
-rw-r--r--docs/usage/usage/dmaap.rst6
-rw-r--r--docs/usage/usage/instantiation.rst10
-rw-r--r--docs/usage/usage/ves.rst2
5 files changed, 14 insertions, 14 deletions
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