Merge pull request #74 from codefuse-ai/lhk_dev

[doc] update COREF Library Reference github pages

Author: zhouang777

doc/tools/build.py

@@ -4,7 +4,7 @@
 subprocess.run([
     "curl",
     "-L",
-    "https://github.com/codefuse-ai/CodeFuse-Query/releases/download/2.0.2/sparrow-cli-2.0.2.linux.tar.gz",
+    "https://github.com/codefuse-ai/CodeFuse-Query/releases/download/2.1.0/sparrow-cli-2.1.0.linux.tar.gz",
     "-o",
     "sparrow-cli.tar.gz"
 ])
@@ -18,4 +18,4 @@
 print("Concat coref library from ../language into ./.coref-api-build")
 subprocess.run(["python3", "tools/generate_coref_library.py", "../language"])
 print("Generate markdown documents into ./godel-api")
-subprocess.run(["python3", "tools/generate_markdown.py", "./sparrow-cli/godel-script/usr/bin/godel"])
+subprocess.run(["python3", "tools/generate_markdown.py", "./sparrow-cli/godel-script/usr/bin/godel"])

doc/tools/generate_coref_library.py

@@ -11,14 +11,19 @@
 if not os.path.exists("./.coref-api-build"):
     os.mkdir("./.coref-api-build")
 
+# merge library files into one file
 mapper = {
+    "coref.cfamily.gdl": input_language_dir + "/cfamily/lib",
     "coref.go.gdl": input_language_dir + "/go/lib",
     "coref.java.gdl": input_language_dir + "/java/lib",
     "coref.javascript.gdl": input_language_dir + "/javascript/lib",
+    "coref.properties.gdl": input_language_dir + "/properties/lib",
     "coref.python.gdl": input_language_dir + "/python/lib",
+    # "coref.sql.gdl": input_language_dir + "/sql/lib",
     "coref.xml.gdl": input_language_dir + "/xml/lib",
 }
 
+# store merged files into .coref-api-build
 for key in mapper.keys():
     output_file = "./.coref-api-build/" + key
     result = ""

doc/tools/generate_markdown.py

@@ -92,9 +92,12 @@ def dump_database(database) -> str:
         result += "[*" + table["type"]["name"] + "](./schema/" + table["type"]["name"] + ".html)\n"
     return result
 
-def dump_schema(comment_list, schema) -> str:
+def dump_schema(comment_list, schema, library_name) -> str:
     result = "---\n"
     result += "layout: default\n"
+    result += "title: " + schema["name"] + "\n"
+    result += "parent: \"schema of coref::" + library_name + "\"\n"
+    result += "grand_parent: \"coref::" + library_name + "\"\n"
     result += "---\n\n"
     result += "# " + schema["name"] + "\n\n"
     comment_of_schema = match_schema_comment(comment_list, schema)
@@ -199,7 +202,7 @@ def dump_schema_tree_view(schema_list) -> str:
     "coref.javascript.gdl": "javascript",
     "coref.properties.gdl": "properties",
     "coref.python.gdl": "python",
-    "coref.sql.gdl": "sql",
+    # "coref.sql.gdl": "sql",
     "coref.xml.gdl": "xml"
 }
 
@@ -216,22 +219,6 @@ def dump_schema_tree_view(schema_list) -> str:
         continue
     semantic_dict[file["name"]] = result.stdout.decode("utf-8")
 
-def dump_reference_main_doc():
-    output_file_path = markdown_output_path + "/coref_library_reference.md"
-    output_data = "---\n"
-    output_data += "title: \"COREF Library Reference\"\n"
-    output_data += "layout: default\n"
-    output_data += "nav_order: 2\n"
-    output_data += "has_children: true\n"
-    output_data += "---\n\n"
-    output_data += "# COREF Library Reference\n\n"
-    for file in input_file_list:
-        output_data += "* [coref::" + name_mapper[file["name"]] + "]"
-        output_data += "(./" + name_mapper[file["name"]] + "/reference.html)\n"
-    open(output_file_path, "w").write(output_data)
-
-dump_reference_main_doc()
-
 assets_count = 0
 
 for file in input_file_list:
@@ -245,8 +232,8 @@ def dump_reference_main_doc():
     output_data = "---\n"
     output_data += "title: \"coref::" + name_mapper[file["name"]] + "\"\n"
     output_data += "layout: default\n"
+    output_data += "nav_order: 2\n"
     output_data += "has_children: true\n"
-    output_data += "parent: \"COREF Library Reference\"\n"
     output_data += "---\n"
     output_data += "# COREF Library Reference for " + name_mapper[file["name"]] + "\n\n"
     output_data += "* coref::" + name_mapper[file["name"]] + " [database](./database.html)\n" 
@@ -259,8 +246,8 @@ def dump_reference_main_doc():
     output_data = "---\n"
     output_data += "title: \"database\"\n"
     output_data += "layout: default\n"
+    output_data += "nav_order: 3\n"
     output_data += "parent: \"coref::" + name_mapper[file["name"]] + "\"\n"
-    output_data += "grand_parent: \"COREF Library Reference\"\n"
     output_data += "---\n"
     output_data += "# Database of " + file["name"] + "\n\n"
     database_list = semantic_info["semantic"]["database"]
@@ -277,8 +264,8 @@ def dump_reference_main_doc():
     output_data = "---\n"
     output_data += "title: \"function\"\n"
     output_data += "layout: default\n"
+    output_data += "nav_order: 3\n"
     output_data += "parent: \"coref::" + name_mapper[file["name"]] + "\"\n"
-    output_data += "grand_parent: \"COREF Library Reference\"\n"
     output_data += "---\n"
     output_data += "# Global Function of " + file["name"] + "\n\n"
     for function in function_list:
@@ -303,17 +290,18 @@ def dump_reference_main_doc():
     assets_count += len(schema_list)
     print("Generate schema documents for", file_full_path, ":", len(schema_list))
     for schema in schema_list:
-        output_data = dump_schema(comment_list, schema)
+        output_data = dump_schema(comment_list, schema, name_mapper[file["name"]])
         output_file_path = markdown_output_path + "/" + name_mapper[file["name"]] + "/schema/" + schema["name"] + ".md"
         open(output_file_path, "w").write(output_data)
 
     # generate schema hierarchy document
     assets_count += 1
     output_data = "---\n"
-    output_data += "title: \"schema\"\n"
+    output_data += "title: \"schema of coref::" + name_mapper[file["name"]] + "\"\n"
     output_data += "layout: default\n"
     output_data += "parent: \"coref::" + name_mapper[file["name"]] + "\"\n"
-    output_data += "grand_parent: \"COREF Library Reference\"\n"
+    output_data += "nav_order: 3\n"
+    output_data += "has_children: true\n"
     output_data += "---\n"
     output_data += "# Schema of " + file["name"] + "\n\n"
     output_data += dump_schema_tree_view(schema_list)