Expose ZCH modules in Documentation (pytorch#1613)

Summary: Pull Request resolved: pytorch#1613 Differential Revision: D52603324
PaulZhang12 · Jan 9, 2024 · 3cf05fa · 3cf05fa
1 parent 3c23d82
commit 3cf05fa
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -1,6 +1,7 @@
 # This workflow builds the torchrec docs and deploys them to gh-pages.
 name: Generate documentation
 on:
+  pull_request:
   push:
     branches:
       - main

diff --git a/docs/source/torchrec.modules.rst b/docs/source/torchrec.modules.rst
@@ -76,10 +76,18 @@ torchrec.modules.utils
    :undoc-members:
    :show-inheritance:
 
-Module contents
+torchrec.modules.mc_modules
 ---------------
 
-.. automodule:: torchrec.modules
+.. automodule:: torchrec.modules.mc_modules
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+torchrec.modules.mc_embedding_modules
+---------------
+
+.. automodule:: torchrec.modules.mc_embedding_modules
    :members:
    :undoc-members:
    :show-inheritance: