[Feature] add colab link to automaitc nb -> md conversion (#473)

Author: mishig25

.github/workflows/build_main_documentation.yml

@@ -154,7 +154,16 @@ jobs:
       
       - name: Convert notebooks to markdown files
         if: inputs.convert_notebooks
-        run: doc-builder notebook-to-mdx ${{ env.doc_folder }}
+        run: |
+          cd ${{ env.doc_folder }}
+          remote_url=$(git remote get-url origin)
+          trimmed_url=${remote_url#https://}
+          trimmed_url=${trimmed_url#github.com/}
+          trimmed_url=${trimmed_url%.git}
+          current_branch=$(git branch --show-current)
+          cd ..
+
+          doc-builder notebook-to-mdx ${{ env.doc_folder }} --open_notebook_prefix https://colab.research.google.com/github/$trimmed_url/blob/$current_branch
 
       - name: Make documentation
         shell: bash

.github/workflows/build_pr_documentation.yml

@@ -140,7 +140,16 @@ jobs:
 
       - name: Convert notebooks to markdown files
         if: inputs.convert_notebooks
-        run: doc-builder notebook-to-mdx ${{ env.doc_folder }}
+        run: |
+          cd ${{ env.doc_folder }}
+          remote_url=$(git remote get-url origin)
+          trimmed_url=${remote_url#https://}
+          trimmed_url=${trimmed_url#github.com/}
+          trimmed_url=${trimmed_url%.git}
+          current_branch=$(git branch --show-current)
+          cd ..
+
+          doc-builder notebook-to-mdx ${{ env.doc_folder }} --open_notebook_prefix https://colab.research.google.com/github/$trimmed_url/blob/$current_branch
 
       - name: Make documentation
         env:

src/doc_builder/commands/notebook_to_mdx.py

@@ -65,6 +65,13 @@ def notebook_to_mdx_command(args):
         mdx_file_name = notebook_path.name[: -len(".ipynb")] + ".md"
         output_dir = notebook_path.parent if args.output_dir is None else Path(args.output_dir).resolve()
         dest_file_path = output_dir / mdx_file_name
+
+        if src_path.is_dir() and args.open_notebook_prefix is not None:
+            relative_path = notebook_path.relative_to(src_path)
+            colab_link = f"{args.open_notebook_prefix}/{str(relative_path)}"
+            colab_link_component = f'<DocNotebookDropdown classNames="absolute z-10 right-0 top-0" options={{[{{label: "Google Colab", value: "{colab_link}"}}]}} />/>'
+            mdx_content = f"{colab_link_component}\n\n" + mdx_content
+
         with open(dest_file_path, "w", encoding="utf-8") as f:
             f.write(mdx_content)
 
@@ -88,6 +95,12 @@ def notebook_to_mdx_command_parser(subparsers=None):
         default=119,
         help="The number of maximum characters per line.",
     )
+    parser.add_argument(
+        "--open_notebook_prefix",
+        type=str,
+        default=None,
+        help="Example: https://colab.research.google.com/github/{user}/{repo}/blob/{branch}",
+    )
 
     if subparsers is not None:
         parser.set_defaults(func=notebook_to_mdx_command)