Add examples as embeded notebooks in the docs/

huggingface · Sep 12, 2024 · e54ecc3 · e54ecc3
1 parent 03e9020
commit e54ecc3
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git a/.github/workflows/doc-build.yml b/.github/workflows/doc-build.yml
@@ -10,13 +10,15 @@ on:
       - .github/workflows/doc-build.yml
 
 jobs:
-   build:
+  build:
     uses: huggingface/doc-builder/.github/workflows/build_main_documentation.yml@main
     with:
       commit_sha: ${{ github.sha }}
       package: Google-Cloud-Containers
       package_name: google-cloud
       additional_args: --not_python_module
+      notebooks_folder: examples
+      convert_notebooks: true
     secrets:
       token: ${{ secrets.HUGGINGFACE_PUSH }}
       hf_token: ${{ secrets.HF_DOC_BUILD_PUSH }}
diff --git a/.github/workflows/doc-pr-build.yml b/.github/workflows/doc-pr-build.yml
@@ -19,3 +19,5 @@ jobs:
       package: Google-Cloud-Containers
       package_name: google-cloud
       additional_args: --not_python_module
+      notebooks_folder: examples
+      convert_notebooks: true
diff --git a/docs/source/_toctree.yml b/docs/source/_toctree.yml
@@ -1,4 +1,8 @@
 - sections:
-  - local: index
-    title: Hugging Face on Google Cloud
+    - local: index
+      title: Hugging Face on Google Cloud
   title: Getting Started
+- sections:
+    - local: notebooks
+      title: Examples
+  title: Examples