1 # Copyright (c) 2018 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
15 from os import walk, listdir
16 from os.path import isfile, isdir, join, getsize
18 # Temporary working directory. It is created and deleted by run_doc.sh
21 # Directory with resources to be documented.
22 RESOURCES_DIR = "resources"
24 # Directory with libraries (python, robot) to be documented.
27 # Directory with tests (func, perf) to be documented.
33 PATH_PY_LIBS = join(WORKING_DIR, RESOURCES_DIR, LIB_DIR, "python")
34 PATH_RF_LIBS = join(WORKING_DIR, RESOURCES_DIR, LIB_DIR, "robot")
35 PATH_TESTS = join(WORKING_DIR, TESTS_DIR)
37 # Sections in rst files
49 rst_rf_suite_setup = """
54 rst_rf_variables = """
70 def get_files(path, extension):
71 """Generates the list of files to process.
73 :param path: Path to files.
74 :param extension: Extension of files to process. If it is the empty string,
75 all files will be processed.
78 :returns: List of files to process.
83 for root, dirs, files in walk(path):
84 for filename in files:
86 if filename.endswith(extension):
87 file_list.append(join(root, filename))
89 file_list.append(join(root, filename))
94 def create_file_name(path, start):
95 """Create the name of rst file.
98 resources.libraries.python.honeycomb.rst
101 :param path: Path to a module to be documented.
102 :param start: The first directory in path which is used in the file name.
108 dir_list = path.split('/')
109 start_index = dir_list.index(start)
110 return ".".join(dir_list[start_index:-1]) + ".rst"
113 def create_rst_file_names_set(files, start):
114 """Generate a set of unique rst file names.
116 :param files: List of all files to be documented with path beginning in the
118 :param start: The first directory in path which is used in the file name.
121 :returns: Set of unique rst file names.
126 file_names.add(create_file_name(file, start))
131 """Create a list of files and directories in the given directory.
133 :param path: Path to the directory.
135 :returns: List of directories and list of files sorted in alphabetical
137 :rtype: tuple of two lists
141 items = listdir(path)
143 if isfile(join(path, item)) and "__init__" not in item:
145 elif isdir(join(path, item)):
147 return sorted(dirs), sorted(files)
150 def write_toc(fh, path, dirs):
151 """Write a table of contents to given rst file.
153 :param fh: File handler of the rst file.
154 :param path: Path to package.
155 :param dirs: List of directories to be included in ToC.
162 fh.write(" {}.{}\n".format('.'.join(path), dir))
165 def write_module_title(fh, module_name):
166 """Write the module title to the given rst file. The title will be on the
169 :param fh: File handler of the rst file.
170 :param module_name: The name of module used for title.
172 :type module_name: str
174 title = "{} suite".format(module_name)
175 fh.write("\n{}\n{}\n".format(title, '-' * len(title)))
178 def generate_py_rst_files():
179 """Generate all rst files for all python modules."""
181 dirs_ignore_list = ["__pycache__", ]
183 py_libs = get_files(PATH_PY_LIBS, PY_EXT)
184 file_names = create_rst_file_names_set(py_libs, RESOURCES_DIR)
186 for file_name in file_names:
187 path = join(WORKING_DIR, *file_name.split('.')[:-1])
188 dirs, files = scan_dir(path)
190 for item in dirs_ignore_list:
197 full_path = join(WORKING_DIR, file_name)
198 with open(full_path, mode='a') as fh:
199 if getsize(full_path) == 0:
200 package = file_name.split('.')[-2]
201 fh.write("{}\n".format(package))
202 fh.write('=' * len("{}".format(package)))
203 module_path = file_name.split('.')[:-1]
205 write_toc(fh, module_path, dirs)
207 module_name = file.split('.')[0]
208 write_module_title(fh, module_name)
209 fh.write(rst_py_module.format('.'.join(module_path),
213 def generate_rf_rst_files(file_names, incl_tests=True, incl_keywords=True,
214 incl_suite_setup=False, incl_variables=False):
215 """Generate rst files for the given robot modules.
217 :param file_names: List of file names to be included in the documentation
219 :param incl_tests: If True, tests will be included in the documentation.
220 :param incl_keywords: If True, keywords will be included in the
222 :param incl_suite_setup: If True, the suite setup will be included in the
224 :param incl_variables: If True, the variables will be included in the
226 :type file_names: set
227 :type incl_tests: bool
228 :type incl_keywords: bool
229 :type incl_suite_setup: bool
230 :type incl_variables: bool
233 for file_name in file_names:
234 path = join(WORKING_DIR, *file_name.split('.')[:-1])
235 dirs, files = scan_dir(path)
237 full_path = join(WORKING_DIR, file_name)
238 with open(full_path, mode='a') as fh:
239 if getsize(full_path) == 0:
240 package = file_name.split('.')[-2]
241 fh.write("{}\n".format(package))
242 fh.write('=' * len("{}".format(package)) + '\n')
243 module_path = file_name.split('.')[:-1]
245 write_toc(fh, module_path, dirs)
247 module_name = file.split('.')[0]
248 write_module_title(fh, module_name)
249 path = join(join(*module_path), module_name + RF_EXT)
251 fh.write(rst_rf_suite_setup.format(path))
253 fh.write(rst_rf_variables.format(path))
255 fh.write(rst_rf_keywords.format(path))
257 fh.write(rst_rf_tests.format(path))
260 def generate_kw_rst_files():
261 """Generate all rst files for all robot modules with keywords in libraries
262 directory (no tests)."""
264 rf_libs = get_files(PATH_RF_LIBS, RF_EXT)
265 file_names = create_rst_file_names_set(rf_libs, RESOURCES_DIR)
267 generate_rf_rst_files(file_names, incl_tests=False)
270 def generate_tests_rst_files():
271 """Generate all rst files for all robot modules with tests in tests
272 directory. Include also keywords defined in these modules."""
274 tests = get_files(PATH_TESTS, RF_EXT)
275 file_names = create_rst_file_names_set(tests, TESTS_DIR)
277 generate_rf_rst_files(file_names,
278 incl_suite_setup=True,
282 if __name__ == '__main__':
284 # Generate all rst files:
285 generate_py_rst_files()
286 generate_kw_rst_files()
287 generate_tests_rst_files()