CSIT Documentation auto generation 62/4362/3
authorTibor Frank <tifrank@cisco.com>
Fri, 16 Dec 2016 11:22:54 +0000 (12:22 +0100)
committerPeter Mikus <pmikus@cisco.com>
Fri, 16 Dec 2016 13:21:59 +0000 (13:21 +0000)
 - remove all *.rst files in env from build
 - add ignore list for directories which will not be included in build

Change-Id: Ifef18255d366094704041b526d707fdb6fc4567d
Signed-off-by: Tibor Frank <tifrank@cisco.com>
resources/tools/doc_gen/gen_rst.py
resources/tools/doc_gen/run_doc.sh

index 8f239d0..e3356f5 100755 (executable)
@@ -170,6 +170,8 @@ def write_module_title(fh, module_name):
 def generate_py_rst_files():
     """Generate all rst files for all python modules."""
 
+    dirs_ignore_list = ["__pycache__", ]
+
     py_libs = get_files(PATH_PY_LIBS, PY_EXT)
     file_names = create_rst_file_names_set(py_libs, RESOURCES_DIR)
 
@@ -177,6 +179,13 @@ def generate_py_rst_files():
         path = join(WORKING_DIR, *file_name.split('.')[:-1])
         dirs, files = scan_dir(path)
 
+        for item in dirs_ignore_list:
+            while True:
+                try:
+                    dirs.remove(item)
+                except ValueError:
+                    break
+
         full_path = join(WORKING_DIR, file_name)
         with open(full_path, mode='a') as fh:
             if getsize(full_path) == 0:
index 1a03707..544554e 100755 (executable)
@@ -41,8 +41,11 @@ export PYTHONPATH=`pwd`
 # Generate rst files:
 ./gen_rst.py
 
+# Remove all rst files from ./${WORKING_DIR}/env directory - we do not need them
+find ./${WORKING_DIR}/env -type f -name '*.rst' | xargs rm -f
+
 # Generate the documentation:
-sphinx-build -vvv -b html ${WORKING_DIR}/ ${BUILD_DIR}/
+sphinx-build -v -b html ${WORKING_DIR} ${BUILD_DIR}/
 
 find . -type d -name 'env' | xargs rm -rf
 

©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.