Documentation generated automatically from .proto files 🔥 (#172)

Dentity-Development · Nov 1, 2021 · 40e8725 · 40e8725
1 parent fb5a760
commit 40e8725
Show file tree

Hide file tree

Showing 3 changed files with 1,613 additions and 0 deletions.
diff --git a/devops/generate_proto_files.py b/devops/generate_proto_files.py
@@ -84,6 +84,15 @@ def update_java():
     shutil.rmtree(join(java_proto_path, 'trinsic', 'okapi'))
 
 
+def update_markdown():
+    lang_path = get_language_dir('docs')
+    lang_proto_path = join(lang_path, 'reference', 'proto')
+    # https://github.com/pseudomuto/protoc-gen-doc
+    # go get -u github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc
+    # Add to path and rename to `protoc-gen-grpc-java`
+    run_protoc({'doc_out': lang_proto_path}, {'doc_opt': 'markdown,index.md'}, get_proto_files())
+
+
 def update_python():
     """
     Generate the protobuf interface files using the python library https://github.com/danielgtaylor/python-betterproto
@@ -111,6 +120,7 @@ def main():
     update_ruby()
     update_java()
     update_python()
+    update_markdown()
 
 
 if __name__ == "__main__":