Check all rst files

It installs doc8 and then checks all rst files.
It also fixes all errors needed for next jjbs.

Change-Id: I30314ece30090ec4923d2c5ad27a9016428102fd
Issue-ID: EXTAPI-163
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

diff --git a/docs/administration/administration.rst b/docs/administration/administration.rst
index 7abffd2..babf452 100644 (file)
--- a/docs/administration/administration.rst
+++ b/docs/administration/administration.rst
@@ -1,5 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
+.. SPDX-License-Identifier: CC-BY-4.0
 .. Copyright 2018 ORANGE
 
 
@@ -14,4 +13,3 @@ Processes
 
 Actions
 -------
-

diff --git a/docs/architecture/architecture.rst b/docs/architecture/architecture.rst
index 31f0235..1ded2f6 100755 (executable)
--- a/docs/architecture/architecture.rst
+++ b/docs/architecture/architecture.rst
@@ -1,6 +1,4 @@
-.. This work is licensed under
-.. a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
+.. SPDX-License-Identifier: CC-BY-4.0
 .. Copyright 2018 ORANGE
 
 
@@ -17,9 +15,9 @@ used by external systems as BSS for example.
 These API are based on **TMF API**.
 
 
-*******************************************
+**********************************************
 Global NBI architecture for Casablanca release
-*******************************************
+**********************************************
 
 Following illustration provides a global view about NBI architecture,
 integration with other ONAP components and API resource/operation provided.
@@ -38,4 +36,3 @@ could be found here: :doc:`NBI_Developer_Guide <NBI_Developer_Guide>`
 
 API Flow illustration (with example messages) is described in this document:
 :download:`nbicallflow.pdf <../offeredapis/pdf/nbicallflow.pdf>`
-

diff --git a/docs/consumedapis/consumedapis.rst b/docs/consumedapis/consumedapis.rst
index 38418b3..02b5782 100755 (executable)
--- a/docs/consumedapis/consumedapis.rst
+++ b/docs/consumedapis/consumedapis.rst
@@ -1,6 +1,4 @@
-.. This work is licensed under
-.. a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
+.. SPDX-License-Identifier: CC-BY-4.0
 .. Copyright 2018 ORANGE
 
 
@@ -57,9 +55,10 @@ SO API
 ******
 
 This API is used to perform Service Order and thus instantiate a service.
-Distinct SO APIs are used for serviceInstance creation request depending on the serviceSpecification category (set in SDC).
-If service could be delivered end-to-end from one request category is set to 'E2E Service'. 
-In this case NBI uses 
+Distinct SO APIs are used for serviceInstance creation request depending on the
+serviceSpecification category (set in SDC). If service could be delivered
+end-to-end from one request category is set to 'E2E Service'.
+In this case NBI uses
 
 ::
 
@@ -69,7 +68,7 @@ In this case NBI uses
 
     MSO_DELETE_REQUEST_STATUS_PATH = "/ecomp/mso/infra/serviceInstances/v6/"
 
-       
+
 else following API are used:
 
 ::
@@ -78,4 +77,4 @@ else following API are used:
 
     MSO_GET_REQUEST_STATUS_PATH = "/ecomp/mso/infra/orchestrationRequests/v6/"
 
-    MSO_DELETE_REQUEST_STATUS_PATH = "/ecomp/mso/infra/serviceInstances/v6/"
\ No newline at end of file
+    MSO_DELETE_REQUEST_STATUS_PATH = "/ecomp/mso/infra/serviceInstances/v6/"

diff --git a/docs/delivery/delivery.rst b/docs/delivery/delivery.rst
index 0bbc8c5..6c79228 100644 (file)
--- a/docs/delivery/delivery.rst
+++ b/docs/delivery/delivery.rst
@@ -1,5 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
+.. SPDX-License-Identifier: CC-BY-4.0
 .. Copyright 2018 ORANGE
 
 
@@ -10,7 +9,8 @@ Delivery
 NBI Dockers Containers Structure
 ********************************
 
-Below is a diagram of the ExternalAPI/NBI project docker containers and the connections between them.
+Below is a diagram of the ExternalAPI/NBI project docker containers and the
+connections between them.
 
 .. blockdiag::
 
@@ -32,4 +32,3 @@ Below is a diagram of the ExternalAPI/NBI project docker containers and the conn
             MongoDB; MariaDB;
         }
     }
-

diff --git a/docs/humaninterfaces/humaninterfaces.rst b/docs/humaninterfaces/humaninterfaces.rst
index 16f1835..506f1d8 100644 (file)
--- a/docs/humaninterfaces/humaninterfaces.rst
+++ b/docs/humaninterfaces/humaninterfaces.rst
@@ -1,5 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
+.. SPDX-License-Identifier: CC-BY-4.0
 .. Copyright 2018 ORANGE
 
 
@@ -8,4 +7,5 @@ Human Interfaces
 
 no Human Interface (pure Rest API project)
 
-Any "Rest Client" application may be used (Postman, ...) to interact with NBI application.
+Any "Rest Client" application may be used (Postman, ...) to interact with NBI
+application.

diff --git a/docs/index.rst b/docs/index.rst
index 5196d1f..f420998 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,5 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
+.. SPDX-License-Identifier: CC-BY-4.0
 .. Copyright 2018 Orange
 
 ONAP ExternalAPI / NBI

diff --git a/docs/installation/installation.rst b/docs/installation/installation.rst
index 89a55fb..ebf8c7a 100644 (file)
--- a/docs/installation/installation.rst
+++ b/docs/installation/installation.rst
@@ -1,6 +1,4 @@
-.. This work is licensed under
-.. a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
+.. SPDX-License-Identifier: CC-BY-4.0
 .. Copyright 2018 ORANGE
 
 
@@ -41,7 +39,8 @@ Defaults
 
     Mongo, host=localhost, port=27017, database=ServiceOrderDB
 
-    Mariadb, url=jdbc:mariadb://localhost:3306/nbi, username=root, password=secret
+    Mariadb, url=jdbc:mariadb://localhost:3306/nbi, username=root,
+    password=secret
 
 Run
 ::
@@ -99,4 +98,3 @@ configuration file and */json/* package with samples requests that can be run.
 **Play with Postman**
 
 A collection is available here *docs/offeredapis/postman*
-

diff --git a/docs/releasenotes/releasenotes.rst b/docs/releasenotes/releasenotes.rst
index 1551e3a..199cc25 100755 (executable)
--- a/docs/releasenotes/releasenotes.rst
+++ b/docs/releasenotes/releasenotes.rst
@@ -1,6 +1,4 @@
-.. This work is licensed under a
-.. Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
+.. SPDX-License-Identifier: CC-BY-4.0
 .. Copyright 2018 ORANGE
 
 Release Notes
@@ -21,7 +19,7 @@ Main features are:
 - `EXTAPI-101 <https://jira.onap.org/browse/EXTAPI-101>`_ - Integrate ExtAPI/NBI to MSB
 - `EXTAPI-102 <https://jira.onap.org/browse/EXTAPI-102>`_ - Integrate ExtAPI/NBI to an E2E ONAP UC
 - `EXTAPI-116 <https://jira.onap.org/browse/EXTAPI-116>`_ - Help NBI user to get information when Service order fails
-- `EXTAPI-125 <https://jira.onap.org/browse/EXTAPI-125>`_ - Hadd support for progress percentage on ServiceOrder tracking
+- `EXTAPI-125 <https://jira.onap.org/browse/EXTAPI-125>`_ - Add support for progress percentage on ServiceOrder tracking
 
 Detail of features described in the readTheDoc documentation.
 
@@ -37,12 +35,10 @@ No new issue (see Beijing ones)
 **Security Notes**
 
 To be completed
- 
+
 Quick Links:
 
 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
-- `Passing Badge information for External API <to be completed>`_
-- `Project Vulnerability Review Table for External API <to be completed>`_
 
 **Upgrade Notes**
 

diff --git a/tox.ini b/tox.ini
new file mode 100644 (file)
index 0000000..1e81466
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,7 @@
+[tox]
+envlist = docs
+skipsdist = True
+
+[testenv]
+deps = doc8
+commands = doc8 docs