docs

Author: SherylHYX

docs/source/conf.py

@@ -9,6 +9,7 @@
 copyright = f'{datetime.datetime.now().year}, {author}'
 
 extensions = [
+    'autoapi.extension',
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
     'sphinx.ext.mathjax',
@@ -36,6 +37,17 @@
 }
 
 add_module_names = False
+autoapi_type = 'python'
+autoapi_dirs = ['../../torch_geometric_signed_directed']
+autoapi_add_toctree_entry = False
+autoapi_python_class_content = 'both'
+autoapi_options = [
+    'members',
+    'undoc-members',
+    'show-inheritance',
+    'show-module-summary',
+]
+
 autodoc_mock_imports = [
     'torch',
     'torch_geometric',

docs/source/modules/model.rst

@@ -4,9 +4,14 @@ PyTorch Geometric Signed Directed Models
 .. contents:: Contents
     :local:
 
-Directed Undirected Network Models and Layers
+Directed (Unsigned) Network Models and Layers
 --------------
 
+This section documents directed graph models and core directed convolution
+layers available in PyTorch Geometric Signed Directed. Each entry includes the
+class/function signature and parameter documentation extracted from source
+docstrings.
+
 .. autoapimodule:: torch_geometric_signed_directed.nn.directed.MagNet_node_classification
     :members:
     :exclude-members:
@@ -70,6 +75,9 @@ Directed Undirected Network Models and Layers
 Signed (Directed) Network Models and Layers
 --------------
 
+This section covers methods tailored to signed graphs (including signed
+directed settings), with links to model and layer level APIs.
+
 .. autoapimodule:: torch_geometric_signed_directed.nn.signed.SSSNET_node_clustering
     :members:
     :exclude-members:
@@ -119,6 +127,9 @@ Signed (Directed) Network Models and Layers
 Auxiliary Methods and Layers
 --------------
 
+This section contains supporting layers and helper operations used by the
+directed and signed model families.
+
 .. autoapimodule:: torch_geometric_signed_directed.nn.directed.complex_relu
     :members:
     :exclude-members: