From 2136bc2e2d5784bd8290045e0543693ff22dca45 Mon Sep 17 00:00:00 2001 From: Svetlana Karslioglu Date: Thu, 12 Sep 2024 09:14:18 -0700 Subject: [PATCH] Example of hiding API --- docs/source/torchrec.modules.rst | 131 ++++++++++++++++--------------- 1 file changed, 69 insertions(+), 62 deletions(-) diff --git a/docs/source/torchrec.modules.rst b/docs/source/torchrec.modules.rst index e2c9ee771..d2f037495 100644 --- a/docs/source/torchrec.modules.rst +++ b/docs/source/torchrec.modules.rst @@ -1,93 +1,100 @@ torchrec.modules ================ -.. automodule:: torchrec.modules +.. + This is a commment and all the indented text is a comment + It will never show up in the final HTML -torchrec.modules.activation ---------------------------- + .. automodule:: torchrec.modules -.. automodule:: torchrec.modules.activation - :members: - :undoc-members: - :show-inheritance: + torchrec.modules.activation + --------------------------- -torchrec.modules.crossnet -------------------------- + .. automodule:: torchrec.modules.activation + :members: + :undoc-members: + :show-inheritance: -.. automodule:: torchrec.modules.crossnet - :members: - :undoc-members: - :show-inheritance: + torchrec.modules.crossnet + ------------------------- -torchrec.modules.deepfm ------------------------ + .. automodule:: torchrec.modules.crossnet + :members: + :undoc-members: + :show-inheritance: -.. automodule:: torchrec.modules.deepfm - :members: - :undoc-members: - :show-inheritance: + torchrec.modules.deepfm + ----------------------- -torchrec.modules.embedding\_configs ------------------------------------ + .. automodule:: torchrec.modules.deepfm + :members: + :undoc-members: + :show-inheritance: -.. automodule:: torchrec.modules.embedding_configs - :members: - :undoc-members: - :show-inheritance: + torchrec.modules.embedding\_configs + ----------------------------------- + + .. automodule:: torchrec.modules.embedding_configs + :members: + :undoc-members: + :show-inheritance: torchrec.modules.embedding\_modules ----------------------------------- -.. automodule:: torchrec.modules.embedding_modules +.. autofunction:: torchrec.modules.embedding_modules :members: :undoc-members: :show-inheritance: -torchrec.modules.feature\_processor ------------------------------------ +.. + This is a comment too and all the indented text below is hidden in the build as well -.. automodule:: torchrec.modules.feature_processor - :members: - :undoc-members: - :show-inheritance: + torchrec.modules.feature\_processor + ----------------------------------- -torchrec.modules.lazy\_extension --------------------------------- + .. automodule:: torchrec.modules.feature_processor + :members: + :undoc-members: + :show-inheritance: -.. automodule:: torchrec.modules.lazy_extension - :members: - :undoc-members: - :show-inheritance: + torchrec.modules.lazy\_extension + -------------------------------- -torchrec.modules.mlp --------------------- + .. automodule:: torchrec.modules.lazy_extension + :members: + :undoc-members: + :show-inheritance: -.. automodule:: torchrec.modules.mlp - :members: - :undoc-members: - :show-inheritance: + torchrec.modules.mlp + -------------------- + .. automodule:: torchrec.modules.mlp + :members: + :undoc-members: + :show-inheritance: -torchrec.modules.utils ----------------------- -.. automodule:: torchrec.modules.utils - :members: - :undoc-members: - :show-inheritance: + torchrec.modules.utils + ---------------------- -torchrec.modules.mc_modules ---------------- + .. automodule:: torchrec.modules.utils + :members: + :undoc-members: + :show-inheritance: -.. automodule:: torchrec.modules.mc_modules - :members: - :undoc-members: - :show-inheritance: + torchrec.modules.mc_modules + --------------- -torchrec.modules.mc_embedding_modules ---------------- + .. automodule:: torchrec.modules.mc_modules + :members: + :undoc-members: + :show-inheritance: -.. automodule:: torchrec.modules.mc_embedding_modules - :members: - :undoc-members: - :show-inheritance: + torchrec.modules.mc_embedding_modules + --------------- + + .. automodule:: torchrec.modules.mc_embedding_modules + :members: + :undoc-members: + :show-inheritance: