Skip to content

Commit 6473b62

Browse files
committed
update docs
1 parent 0204d19 commit 6473b62

File tree

5 files changed

+18
-5
lines changed

5 files changed

+18
-5
lines changed

docs/source/api/encoder.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,13 @@ Molecular Encoder Models
33

44
This section documents the encoder(representation learning) models in `torch_molecule.encoder`.
55

6-
.. rubric:: MoAma for Molecular Representation Learning
6+
.. contents::
7+
:local:
8+
:depth: 1
79

10+
.. rubric:: MoAma for Molecular Representation Learning
811
.. automodule:: torch_molecule.encoder.moama
9-
:members:
12+
:members:
1013
:undoc-members:
1114
:show-inheritance:
1215

docs/source/api/generator.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ Molecular Generation Models
33

44
This section documents the generation models in `torch_molecule.generator`.
55

6+
.. contents::
7+
:local:
8+
:depth: 1
9+
610
.. rubric:: GraphDiT for Un/Multi-conditional Molecular Generation
711

812
.. automodule:: torch_molecule.generator.graph_dit

docs/source/api/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@ API Reference
44
This section documents the main modules and classes in `torch_molecule`.
55

66
.. toctree::
7-
:maxdepth: 2
7+
:maxdepth: 3
88
:caption: Main Components:
9+
:hidden:
910

1011
predictor
1112
generator

docs/source/api/predictor.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ Molecular Property Prediction Models
33

44
This section documents the predictor models in `torch_molecule.predictor`.
55

6+
.. contents::
7+
:local:
8+
:depth: 1
9+
610
.. (Add predictors here as needed. You might write summaries and link submodules.)
711
812
.. rubric:: Graph Neural Networks

docs/source/index.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,9 @@ Welcome to the torch-molecule documentation. torch-molecule is an actively devel
1818
example
1919

2020
.. toctree::
21-
:maxdepth: 2
22-
:caption: API for main modules:
21+
:maxdepth: 3
22+
:caption: Main Components:
23+
:hidden:
2324

2425
api/predictor
2526
api/generator

0 commit comments

Comments
 (0)