Support for sphinx_copybutton (#342)

pyg-team · Aug 17, 2024 · fb0b5df · fb0b5df
1 parent 2eaa705
commit fb0b5df
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -20,6 +20,7 @@
     'sphinx.ext.mathjax',
     'sphinx.ext.napoleon',
     'sphinx.ext.viewcode',
+    'sphinx_copybutton',
     'pyg',
 ]
 

diff --git a/pyg_lib/ops/__init__.py b/pyg_lib/ops/__init__.py
@@ -104,7 +104,8 @@ def grouped_matmul(
     r"""Performs dense-dense matrix multiplication according to groups,
     utilizing dedicated kernels that effectively parallelize over groups.
 
-    Example:
+    .. code-block:: python
+
         inputs = [torch.randn(5, 16), torch.randn(3, 32)]
         others = [torch.randn(16, 32), torch.randn(32, 64)]
 
@@ -147,7 +148,8 @@ def segment_matmul(
     the first dimension of :obj:`inputs` as given by :obj:`ptr`, utilizing
     dedicated kernels that effectively parallelize over groups.
 
-    Example:
+    .. code-block:: python
+
         inputs = torch.randn(8, 16)
         ptr = torch.tensor([0, 5, 8])
         other = torch.randn(2, 16, 32)