docs

Author: SherylHYX

docs/requirements.txt

@@ -1,4 +1,6 @@
-sphinx==7.0
+sphinx
 sphinx-rtd-theme
 sphinx-autoapi
-Jinja2>=3.0
+numpy
+scipy
+networkx

docs/source/conf.py

@@ -1,29 +1,26 @@
 import datetime
-import doctest
 import os
 import sys
 
 import sphinx_rtd_theme
 
 sys.path.insert(0, os.path.abspath('../../'))
 
+project = 'PyTorch Geometric Signed Directed'
+author = 'Yixuan He'
+copyright = f'{datetime.datetime.now().year}, {author}'
+
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.autosummary',
-    'sphinx.ext.doctest',
+    'autoapi.extension',
     'sphinx.ext.intersphinx',
     'sphinx.ext.mathjax',
     'sphinx.ext.napoleon',
     'sphinx.ext.viewcode',
     'sphinx.ext.githubpages',
 ]
 
-source_suffix = '.rst'
 master_doc = 'modules/root'
-
-project = 'PyTorch Geometric Signed Directed'
-author = 'Yixuan He'
-copyright = '{}, {}'.format(datetime.datetime.now().year, author)
+source_suffix = '.rst'
 
 html_theme = 'sphinx_rtd_theme'
 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
@@ -38,24 +35,26 @@
 html_static_path = ['_static']
 html_context = {'css_files': ['_static/css/custom.css']}
 
-doctest_default_flags = doctest.NORMALIZE_WHITESPACE
-intersphinx_mapping = {'python': ('https://docs.python.org/', None)}
-add_module_names = False
-autosummary_generate = True
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3', None),
+}
 
-autodoc_mock_imports = [
-    'torch',
-    'torch_geometric',
-    'torch_sparse',
-    'torch_scatter',
+autoapi_type = 'python'
+autoapi_dirs = [os.path.abspath('../../torch_geometric_signed_directed')]
+autoapi_file_patterns = ['*.py']
+autoapi_root = 'modules/_autoapi'
+autoapi_keep_files = True
+autoapi_add_toctree_entry = False
+autoapi_options = [
+    'members',
+    'undoc-members',
+    'show-inheritance',
+    'show-module-summary',
+    'special-members',
+    'imported-members',
 ]
 
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
-
 def setup(app):
-    def skip(app, what, name, obj, skip, options):
-        members = ['__init__', '__repr__', '__weakref__', '__dict__', '__module__']
-        return True if name in members else skip
-
-    app.connect('autodoc-skip-member', skip)
+    app.add_css_file('css/custom.css')

docs/source/index.rst

@@ -1,12 +1,11 @@
 PyTorch Geometric Signed Directed
 =================================
 
-PyTorch Geometric Signed Directed is a signed and directed graph neural
-network extension library for PyTorch Geometric.
+This documentation is centered on the package API.
 
 .. toctree::
    :maxdepth: 1
 
+   modules/root
    notes/installation
-   notes/introduction
-   modules/root
+   notes/introduction

docs/source/modules/root.rst

@@ -1,94 +1,13 @@
-Package Reference
-=================
+PyTorch Geometric Signed Directed
+=================================
+
+Signed and directed graph neural network utilities for PyTorch Geometric.
 
 .. 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
-^^^^^^^^^^^^^^^^^
+Package API
+-----------
 
-.. automodule:: torch_geometric_signed_directed.utils.general
-   :members:
-   :undoc-members:
-   :show-inheritance:
+.. autoapi-tree::
+   :nosignatures: