docs

Author: SherylHYX

.readthedocs.yml

@@ -10,4 +10,4 @@ sphinx:
 
 python:
   install:
-    - requirements: docs/requirements.txt
+    - requirements: docs/requirements.txt

docs/source/conf.py

@@ -1,9 +1,15 @@
 import datetime
 import doctest
+import os
+import sys
+
 import sphinx_rtd_theme
 
+sys.path.insert(0, os.path.abspath('../../'))
+
 extensions = [
-    'autoapi.extension',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
     'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
     'sphinx.ext.mathjax',
@@ -14,29 +20,28 @@
 
 source_suffix = '.rst'
 master_doc = 'index'
-author = 'Yixuan He'
+
 project = 'PyTorch Geometric Signed Directed'
+author = 'Yixuan He'
 copyright = '{}, {}'.format(datetime.datetime.now().year, author)
 
 html_theme = 'sphinx_rtd_theme'
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 html_theme_options = {
     'collapse_navigation': False,
     'display_version': True,
     'logo_only': True,
+    'navigation_depth': 2,
 }
 
-doctest_default_flags = doctest.NORMALIZE_WHITESPACE
-intersphinx_mapping = {'python': ('https://docs.python.org/', None)}
-
 html_logo = '_static/img/text_logo.jpg'
 html_static_path = ['_static']
 html_context = {'css_files': ['_static/css/custom.css']}
-add_module_names = False
 
-autoapi_type = 'python'
-autoapi_dirs = ['../../torch_geometric_signed_directed/']
-autoapi_keep_files = True
-autoapi_generate_api_docs = True
+doctest_default_flags = doctest.NORMALIZE_WHITESPACE
+intersphinx_mapping = {'python': ('https://docs.python.org/', None)}
+add_module_names = False
+autosummary_generate = True
 
 autodoc_mock_imports = [
     'torch',
@@ -45,6 +50,9 @@
     'torch_scatter',
 ]
 
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
 def setup(app):
     def skip(app, what, name, obj, skip, options):
         members = ['__init__', '__repr__', '__weakref__', '__dict__', '__module__']

docs/source/index.rst

@@ -1,17 +1,21 @@
 :github_url: https://github.com/SherylHYX/pytorch_geometric_signed_directed
 
 PyTorch Geometric Signed Directed Documentation
-========================================
+==============================================
 
-PyTorch Geometric Signed Directed is a signed/directed graph neural network extension library for `PyTorch Geometric <https://github.com/rusty1s/pytorch_geometric/>`_.  
-It builds on open-source deep-learning and graph processing libraries. 
-*PyTorch Geometric Signed Directed* consists of various signed and directed geometric deep learning, embedding, and clustering methods from a variety of published research papers and selected preprints.
+PyTorch Geometric Signed Directed is a signed and directed graph neural
+network extension library for PyTorch Geometric. It provides models, data
+loaders, and utilities for signed and directed graph learning.
 
+This documentation is organized into two parts:
+
+- **Notes** — installation, overview, datasets, and examples.
+- **Package Reference** — API documentation for the library.
 
 .. toctree::
-   :glob:
    :maxdepth: 2
    :caption: Notes
+   :glob:
 
    notes/installation
    notes/introduction
@@ -20,10 +24,8 @@ It builds on open-source deep-learning and graph processing libraries.
    notes/datasets
 
 .. toctree::
-   :glob:
-   :maxdepth: 3
+   :maxdepth: 2
    :caption: Package Reference
+   :glob:
 
-   modules/model
-   modules/data
-   modules/utils
+   modules/root

docs/source/modules/root.rst

@@ -0,0 +1,94 @@
+Package Reference
+=================
+
+.. contents:: Contents
+   :local:
+
+Top-level package
+-----------------
+
+.. automodule:: torch_geometric_signed_directed
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Data
+----
+
+Directed data
+^^^^^^^^^^^^^
+
+.. automodule:: torch_geometric_signed_directed.data.directed
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Signed data
+^^^^^^^^^^^
+
+.. automodule:: torch_geometric_signed_directed.data.signed
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+General data
+^^^^^^^^^^^^
+
+.. automodule:: torch_geometric_signed_directed.data.general
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Neural network modules
+----------------------
+
+Directed models
+^^^^^^^^^^^^^^^
+
+.. automodule:: torch_geometric_signed_directed.nn.directed
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Signed models
+^^^^^^^^^^^^^
+
+.. automodule:: torch_geometric_signed_directed.nn.signed
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+General models
+^^^^^^^^^^^^^^
+
+.. automodule:: torch_geometric_signed_directed.nn.general
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Utilities
+---------
+
+Directed utilities
+^^^^^^^^^^^^^^^^^^
+
+.. automodule:: torch_geometric_signed_directed.utils.directed
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Signed utilities
+^^^^^^^^^^^^^^^^
+
+.. automodule:: torch_geometric_signed_directed.utils.signed
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+General utilities
+^^^^^^^^^^^^^^^^^
+
+.. automodule:: torch_geometric_signed_directed.utils.general
+   :members:
+   :undoc-members:
+   :show-inheritance: