Merge "[placement] Fix placement-api-ref check tool"

tools/placement_api_docs.py

@@ -11,6 +11,7 @@
 #    under the License.
 """Test to see if docs exists for routes and methods in the placement API."""
 
+import os
 import sys
 
 from nova.api.openstack.placement import handler
@@ -25,8 +26,8 @@ def _header_line(map_entry):
     return line
 
 
-def inspect_doc(doc_file):
-    """Load up doc_file and see if any routes are missing.
+def inspect_doc(doc_files):
+    """Load up doc_files and see if any routes are missing.
 
     The routes are defined in handler.ROUTE_DECLARATIONS.
     """
@@ -42,8 +43,10 @@ def inspect_doc(doc_file):
     for map_entry in routes:
         header_lines.append(_header_line(map_entry))
 
-    with open(doc_file) as doc_fh:
-        content_lines = doc_fh.read().splitlines()
+    content_lines = []
+    for doc_file in doc_files:
+        with open(doc_file) as doc_fh:
+            content_lines.extend(doc_fh.read().splitlines())
 
     missing_lines = []
     for line in header_lines:
@@ -60,5 +63,7 @@ def inspect_doc(doc_file):
 
 
 if __name__ == '__main__':
-    doc_file = sys.argv[1]
-    sys.exit(inspect_doc(doc_file))
+    path = sys.argv[1]
+    doc_files = [os.path.join(path, file)
+                 for file in os.listdir(path) if file.endswith(".inc")]
+    sys.exit(inspect_doc(doc_files))

tox.ini

@@ -148,7 +148,7 @@ commands =
   # TODO(cdent): Get rid of the leading '-' after all the existing
   # routes have been documented. It causes the non-zero exit code to
   # ignored.
-  - python tools/placement_api_docs.py placement-api-ref/source/index.rst
+  - python tools/placement_api_docs.py placement-api-ref/source/
   rm -rf placement-api-ref/build
   sphinx-build -W -b html -d placement-api-ref/build/doctrees placement-api-ref/source placement-api-ref/build/html