CSIT doc gen: remove "package" and change "module" to "suite" 66/4866/2
authorTibor Frank <tifrank@cisco.com>
Wed, 25 Jan 2017 11:20:31 +0000 (12:20 +0100)
committerPeter Mikus <pmikus@cisco.com>
Thu, 26 Jan 2017 07:27:58 +0000 (07:27 +0000)
Change-Id: I36664eb4c1ade7c2c96df457ed939f8681ba2dce
Signed-off-by: Tibor Frank <tifrank@cisco.com>
resources/tools/doc_gen/gen_rst.py

index e3356f5..c79ffc0 100755 (executable)
@@ -163,7 +163,7 @@ def write_module_title(fh, module_name):
     :type fh: file
     :type module_name: str
     """
-    title = "{} module".format(module_name)
+    title = "{} suite".format(module_name)
     fh.write("\n{}\n{}\n".format(title, '-' * len(title)))
 
 
@@ -190,8 +190,8 @@ def generate_py_rst_files():
         with open(full_path, mode='a') as fh:
             if getsize(full_path) == 0:
                 package = file_name.split('.')[-2]
-                fh.write("{} package\n".format(package))
-                fh.write('=' * len("{} package".format(package)))
+                fh.write("{}\n".format(package))
+                fh.write('=' * len("{}".format(package)))
             module_path = file_name.split('.')[:-1]
             if dirs:
                 write_toc(fh, module_path, dirs)
@@ -222,8 +222,8 @@ def generate_rf_rst_files(file_names, incl_tests=True, incl_keywords=True):
         with open(full_path, mode='a') as fh:
             if getsize(full_path) == 0:
                 package = file_name.split('.')[-2]
-                fh.write("{} package\n".format(package))
-                fh.write('=' * len("{} package".format(package)) + '\n')
+                fh.write("{}\n".format(package))
+                fh.write('=' * len("{}".format(package)) + '\n')
             module_path = file_name.split('.')[:-1]
             if dirs:
                 write_toc(fh, module_path, dirs)

©2016 FD.io a Linux Foundation Collaborative Project. All Rights Reserved.
Linux Foundation is a registered trademark of The Linux Foundation. Linux is a registered trademark of Linus Torvalds.
Please see our privacy policy and terms of use.