From 91e46a66d75bf2f2959f4b47a3077f39623887bb Mon Sep 17 00:00:00 2001 From: Shirshanka Das Date: Mon, 9 May 2022 10:50:25 -0700 Subject: [PATCH] fix(docs): ingest - sort modules, fix small typos --- metadata-ingestion/scripts/docgen.py | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/metadata-ingestion/scripts/docgen.py b/metadata-ingestion/scripts/docgen.py index 402030f530463f..e60ba7de772f6d 100644 --- a/metadata-ingestion/scripts/docgen.py +++ b/metadata-ingestion/scripts/docgen.py @@ -657,7 +657,7 @@ def generate( # f.write("| Source Module | Documentation |\n") # f.write("| ------ | ---- |\n") - for plugin in platform_docs["plugins"]: + for plugin in sorted(platform_docs["plugins"]): f.write("\n") f.write(f"\n\n`{plugin}`\n\n\n") f.write( @@ -667,11 +667,12 @@ def generate( # f.write( # f"| `{plugin}` | {get_snippet(platform_docs['plugins'][plugin]['source_doc'])}[Read more...](#module-{plugin}) |\n" # ) - f.write("\n") + f.write("\n\n") # insert platform level custom docs before plugin section f.write(platform_docs.get("custom_docs") or "") - for plugin, plugin_docs in platform_docs["plugins"].items(): - f.write(f"\n## Module `{plugin}`\n") + for plugin in sorted(platform_docs["plugins"]): + plugin_docs = platform_docs["plugins"][plugin] + f.write(f"\n\n## Module `{plugin}`\n") if "support_status" in plugin_docs: f.write( get_support_status_badge(plugin_docs["support_status"]) + "\n\n" @@ -694,7 +695,7 @@ def generate( f.write("### Install the Plugin\n") if plugin_docs["extra_deps"] != []: f.write("```shell\n") - f.write(f"pip install 'acryl-datahub[{plugin}]`\n") + f.write(f"pip install 'acryl-datahub[{plugin}]'\n") f.write("```\n") else: f.write(