Merge pull request #52 from hpe-container-platform-community/travis_flake_check_numpy_docs

turn on flake numpy docstring check

Author: snowch

.travis.yml

@@ -23,6 +23,20 @@ after_success:
 
 jobs:
   include:
+    - stage: flake8_code
+      name: "Flake8 code checks"
+      python: 3.8
+      install:
+        - pip3 install flake8 flake8-per-file-ignores
+      script:
+        - flake8 bin/ hpecp/ tests/
+    - stage: flake8_docs
+      name: "Flake8 doc checks"
+      python: 3.8
+      install:
+        - pip3 install flake8 flake8-docstrings flake8-per-file-ignores
+      script:
+        - flake8 --exclude hpecp/client.py,hpecp/catalog.py,hpecp/config.py,hpecp/gateway.py,hpecp/logger.py,hpecp/lock.py,hpecp/k8s_cluster.py,hpecp/k8s_worker.py,hpecp/license.py,hpecp/exceptions.py,hpecp/user.py,hpecp/tenant.py,hpecp/role.py --docstring-convention numpy bin/ hpecp/
     - stage: coverage_library
       name: "Code coverage LIBRARY (./hpecp)"
       python: 3.8
@@ -41,13 +55,6 @@ jobs:
         - coverage erase
         - coverage run --source bin setup.py test
         - coverage report -m --fail-under 32
-    - stage: flake8
-      name: "Flake8 code checks"
-      python: 3.8
-      install:
-        - pip3 install flake8 # TODO: install 'flake8-docstrings'
-      script:
-        - flake8 bin/ hpecp/ tests/ # TODO: add docstring 'flake8 --docstring-convention numpy hpecp/ bin/ tests/'
     - stage: format
       name: "Check code formatting"
       python: 3.8

DEVELOPING.md

@@ -56,7 +56,15 @@ hpecp license platform-id
   - `GET /api/v1/role/99` (returns HTTP 404 - not found)
 
 
-#### BUILDING DOCS
+### DOCS
+
+#### format
+
+Numpy docstring format are required: https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard
+
+Docstring formatting is verified with flake8 as Travis build step.
+
+#### Building
 
 In the Gitpod Terminal:
 
@@ -113,6 +121,12 @@ Aim for 100% test coverage to ensure library will work with all specified python
 coverage erase && coverage run --source hpecp,bin setup.py test && coverage report -m
 ```
 
+### CODE QUALITY
+
+```
+pip3 install flake8 flake8-docstrings
+flake8 --docstring-convention numpy bin/ hpecp/ tests/
+```
 
 ### FORMATTING
 

bin/__init__.py

@@ -0,0 +1 @@
+# noqa: D104