Merge "Enable all Sphinx build warnings as errors"

diff --git a/docs/admin-guide.rst b/docs/admin-guide.rst
index a7439ef..c2643f8 100644 (file)
--- a/docs/admin-guide.rst
+++ b/docs/admin-guide.rst
@@ -30,7 +30,7 @@ Logging Configuration
 CPS Log pattern
 ---------------
 
-.. code-block:: java
+.. code-block::
 
    <pattern>
        {
@@ -50,7 +50,7 @@ Change logging level
 
 - Curl command 1. Check current log level of "logging.level.org.onap.cps" if it is set to it's default value (INFO)
 
-.. code-block:: java
+.. code-block:: bash
 
     curl --location --request GET 'http://{cps-service-name:cps-management-port}/manage/loggers/org.onap.cps' \
     --header 'Content-Type: application/json; charset=utf-8'
@@ -68,7 +68,7 @@ Change logging level
 .. note::
    Below-mentioned endpoint  will change the log level at runtime. After executing the curl command "effectiveLevel" will set and applied immediately without restarting CPS service.
 
-.. code-block:: java
+.. code-block:: bash
 
     curl --location --request POST 'http://{cps-service-name:cps-management-port}/manage/loggers/org.onap.cps' \
     --header 'Content-Type: application/json; charset=utf-8' \
@@ -80,7 +80,7 @@ Change logging level
 
 - Curl command 3. Verify if log level of "logging.level.org.onap.cps" is changed from 'INFO' to 'DEBUG'
 
-.. code-block:: java
+.. code-block:: bash
 
     curl --location --request GET 'http://{cps-service-name:cps-management-port}/manage/loggers/org.onap.cps' \
     --header 'Content-Type: application/json; charset=utf-8'
@@ -109,7 +109,7 @@ Measure Execution Time of CPS Service
 
 Execute CPS service that you want to calculate total elapsed time and log as shown below
 
-.. code-block:: xml
+.. code-block::
 
    2022-01-28 18:39:17.679 DEBUG [cps-application,e17da1571e518c59,e17da1571e518c59] 11128 --- [tp1901272535-29] o.onap.cps.aop.CpsLoggingAspectService   : Execution time of : DataspaceRepository.getByName() with argument[s] = [test42] having result = org.onap.cps.spi.entities.DataspaceEntity@68ded236 :: 205 ms
 

diff --git a/docs/conf.py b/docs/conf.py
index 5185b61..e8bb663 100755 (executable)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -38,7 +38,8 @@ html_show_sphinx = False
 
 extensions = [
     'sphinx.ext.intersphinx','sphinxcontrib.blockdiag',
-    'sphinxcontrib.seqdiag', 'sphinxcontrib.swaggerdoc', 'sphinx.ext.graphviz']
+    'sphinxcontrib.seqdiag', 'sphinxcontrib.swaggerdoc', 'sphinx.ext.graphviz',
+    'sphinxcontrib.spelling']
 
 #
 # Map to 'latest' if this file is used in 'latest' (master) 'doc' branch.

diff --git a/docs/cps-events.rst b/docs/cps-events.rst
index df37de3..d487018 100644 (file)
--- a/docs/cps-events.rst
+++ b/docs/cps-events.rst
@@ -27,7 +27,7 @@ Event header
         "eventTarget"           : "test-topic",
         "eventType"             : "org.onap.cps.ncmp.event.model.DmiAsyncRequestResponseEvent",
         "eventSchema"           : "urn:cps:org.onap.cps.ncmp.event.model.DmiAsyncRequestResponseEvent:v1",
-        "forwarded-Event"       : { ... }
+        "forwarded-Event"       : { }
     }
 
 Forwarded-Event Payload
@@ -46,7 +46,7 @@ Forwarded-Event Payload
         "response-data-schema"  : "urn:cps:org.onap.cps.ncmp.event.model.DmiAsyncRequestResponseEvent:v1",
         "response-status"       : "OK",
         "response-code"         : "200",
-        "response-data"         : { ... }
+        "response-data"         : { }
     }
 
 
@@ -77,7 +77,7 @@ Events header
 ^^^^^^^^^^^^^
 *Event header prototype for all event types*
 
-.. code-block:: json
+.. code-block::
 
   {
       "eventId"                : "00001",
@@ -86,8 +86,8 @@ Events header
       "eventSource"            : "org.onap.ncmp",
       "eventType"              : "org.onap.ncmp.cmhandle-lcm-event.create",
       "eventSchema"            : "org.onap.ncmp:cmhandle-lcm-event",
-      "eventSchemaVersion"        : "1.0"
-      "event": ....
+      "eventSchemaVersion"     : "1.0",
+      "event"                  : ...
   }
 
 Events payload

diff --git a/docs/deployment.rst b/docs/deployment.rst
index c7504e2..2e72c0a 100644 (file)
--- a/docs/deployment.rst
+++ b/docs/deployment.rst
@@ -247,7 +247,7 @@ Any spring supported property can be configured by providing in ``config.additio
 | notification.data-updated.topic       |                                                                                                         |                               |
 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 | config.additional.                    | Array of dataspaces to be enabled for publishing events to cps-temporal                                 | []                            |
-| notification.data-updated.filters.    | If left blank CPS-Temporal notification will be sent for all dataspaces                                  |                               |
+| notification.data-updated.filters.    | If left blank CPS-Temporal notification will be sent for all dataspaces                                 |                               |
 | enabled-dataspaces                    |                                                                                                         |                               |
 +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+
 | config.additional.                    | If asynchronous messaging, user notifications, and updated event persistence should be enabled          | ``true``                      |

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 93844b8..12e485a 100755 (executable)
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -182,6 +182,7 @@ Release Data
 | **Release date**                     | 2023 January 27                                        |
 |                                      |                                                        |
 +--------------------------------------+--------------------------------------------------------+
+
 Features
 --------
 3.2.1

diff --git a/docs/tox.ini b/docs/tox.ini
index ab2de1b..8684276 100644 (file)
--- a/docs/tox.ini
+++ b/docs/tox.ini
@@ -27,7 +27,7 @@ deps =
     -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 -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html
+    sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html
 [testenv:docs-linkcheck]
 basepython = python3.8
 deps =
@@ -35,7 +35,7 @@ deps =
     -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 -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck
+    sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck
 [testenv:docs-spellcheck]
 basepython = python3.8
 deps =
@@ -43,4 +43,4 @@ deps =
     -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 -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck
+    sphinx-build -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck