Skip to content

Commit cc55f3f

Browse files
committed
add comments in build script
1 parent 2b75582 commit cc55f3f

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

doc/tools/generate_markdown.py

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,12 +232,16 @@ def dump_reference_main_doc():
232232

233233
dump_reference_main_doc()
234234

235+
assets_count = 0
236+
235237
for file in input_file_list:
236238
file_full_path = file["path"] + "/" + file["name"]
237239
print("Generate markdown for " + file_full_path)
238240
semantic_info = json.loads(semantic_dict[file["name"]])
239241
comment_list = semantic_info["comments"]
240242

243+
# generate reference.md
244+
assets_count += 1
241245
output_data = "---\n"
242246
output_data += "title: \"coref::" + name_mapper[file["name"]] + "\"\n"
243247
output_data += "layout: default\n"
@@ -251,6 +255,7 @@ def dump_reference_main_doc():
251255
output_file_path = markdown_output_path + "/" + name_mapper[file["name"]] + "/reference.md"
252256
open(output_file_path, "w").write(output_data)
253257

258+
# generate database.md
254259
output_data = "---\n"
255260
output_data += "title: \"database\"\n"
256261
output_data += "layout: default\n"
@@ -259,13 +264,16 @@ def dump_reference_main_doc():
259264
output_data += "---\n"
260265
output_data += "# Database of " + file["name"] + "\n\n"
261266
database_list = semantic_info["semantic"]["database"]
267+
assets_count += 1
262268
for database in database_list:
263269
output_data += dump_database(database)
264270
output_file_path = markdown_output_path + "/" + name_mapper[file["name"]] + "/database.md"
265271
print("Generate", output_file_path)
266272
open(output_file_path, "w").write(output_data)
267273

274+
# generate function.md
268275
function_list = semantic_info["semantic"]["function"]
276+
assets_count += 1
269277
output_data = "---\n"
270278
output_data += "title: \"function\"\n"
271279
output_data += "layout: default\n"
@@ -290,13 +298,17 @@ def dump_reference_main_doc():
290298
print("Generate", output_file_path)
291299
open(output_file_path, "w").write(output_data)
292300

301+
# generate schema documents
293302
schema_list = semantic_info["semantic"]["schema"]
303+
assets_count += len(schema_list)
294304
print("Generate schema documents for", file_full_path, ":", len(schema_list))
295305
for schema in schema_list:
296306
output_data = dump_schema(comment_list, schema)
297307
output_file_path = markdown_output_path + "/" + name_mapper[file["name"]] + "/schema/" + schema["name"] + ".md"
298308
open(output_file_path, "w").write(output_data)
299309

310+
# generate schema hierarchy document
311+
assets_count += 1
300312
output_data = "---\n"
301313
output_data += "title: \"schema\"\n"
302314
output_data += "layout: default\n"
@@ -307,4 +319,6 @@ def dump_reference_main_doc():
307319
output_data += dump_schema_tree_view(schema_list)
308320
output_file_path = markdown_output_path + "/" + name_mapper[file["name"]] + "/schema.md"
309321
open(output_file_path, "w").write(output_data)
310-
print("Generate schema documents for", file_full_path, ": Done")
322+
print("Generate schema documents for", file_full_path, ": Done")
323+
324+
print("Generation complete, total api count:", assets_count)

0 commit comments

Comments
 (0)