Skip to content

Bring back composite documentation #331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 29, 2022
Merged

Bring back composite documentation #331

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f3d45c
update
rusty1s Oct 29, 2022
e2b4401
update
rusty1s Oct 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
import datetime
import sphinx_rtd_theme
import doctest

import sphinx_rtd_theme
import torch_scatter

extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.mathjax',
'sphinx.ext.napoleon',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
]

source_suffix = '.rst'
Expand Down
8 changes: 8 additions & 0 deletions docs/source/functions/composite.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
composite
=========

.. currentmodule:: torch_scatter.composite

.. automodule:: torch_scatter.composite
:members:
:undoc-members:
5 changes: 4 additions & 1 deletion docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,10 @@ All included operations are broadcastable, work on varying data types, are imple
:maxdepth: 0
:caption: Package reference

functions/*
functions/scatter
functions/segment_coo
functions/segment_csr
functions/composite

Indices and tables
==================
Expand Down