updates

Author: SherylHYX

.github/workflows/main.yml

@@ -14,16 +14,16 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: [3.8, 3.9]
+        python-version: [3.11, 3.12]
         os: [ubuntu-latest]
         torch-version: [2.3.0]
         include:
           - torch-version: 2.3.0
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
@@ -37,11 +37,12 @@ jobs:
     - run: which python
     - name: Run installation.
       run: |
+        python -m pip install --upgrade pip
         python -m pip install torch==2.3.0 torchvision torchaudio -f https://download.pytorch.org/whl/cpu/torch_stable.html
         python -m pip install torch-sparse -f https://data.pyg.org/whl/torch-2.3.0+cpu.html
         python -m pip install torch-scatter -f https://data.pyg.org/whl/torch-2.3.0+cpu.html
         python -m pip install torch-geometric
-        python -m pip install sphinx sphinx_rtd_theme
+        python -m pip install sphinx sphinx-rtd-theme
         python -m pip install -e .[test]
     - name: Lint with flake8
       run: |

.readthedocs.yml

@@ -1,17 +1,13 @@
 version: 2
 
 build:
-   os: ubuntu-22.04
-   tools:
-      python: "3.9"
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
 
-python:
-   install:
-      - requirements: docs/requirements.txt
-      - method: setuptools
-        path: .
-      
 sphinx:
   configuration: docs/source/conf.py
 
-formats: []
+python:
+  install:
+    - requirements: docs/requirements.txt

docs/requirements.txt

@@ -1,5 +1,4 @@
-https://download.pytorch.org/whl/cpu/torch-1.13.0%2Bcpu-cp39-cp39-linux_x86_64.whl
-numpy>=1.19.5
-git+https://github.com/pyg-team/pyg_sphinx_theme.git
-scipy
-networkx
+sphinx==7.0
+sphinx-rtd-theme
+sphinx-autoapi
+Jinja2>=3.0

docs/source/conf.py

@@ -1,10 +1,9 @@
 import datetime
-import sphinx_rtd_theme
 import doctest
-import torch_geometric_signed_directed
+import sphinx_rtd_theme
 
 extensions = [
-    'sphinx.ext.autodoc',
+    'autoapi.extension',
     'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
     'sphinx.ext.mathjax',
@@ -15,39 +14,40 @@
 
 source_suffix = '.rst'
 master_doc = 'index'
-
 author = 'Yixuan He'
 project = 'PyTorch Geometric Signed Directed'
 copyright = '{}, {}'.format(datetime.datetime.now().year, author)
 
 html_theme = 'sphinx_rtd_theme'
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
-
-doctest_default_flags = doctest.NORMALIZE_WHITESPACE
-intersphinx_mapping = {'python': ('https://docs.python.org/', None)}
-
 html_theme_options = {
     'collapse_navigation': False,
     'display_version': True,
     'logo_only': True,
 }
 
+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
+
+autodoc_mock_imports = [
+    'torch',
+    'torch_geometric',
+    'torch_sparse',
+    'torch_scatter',
+]
 
 def setup(app):
     def skip(app, what, name, obj, skip, options):
-        members = [
-            '__init__',
-            '__repr__',
-            '__weakref__',
-            '__dict__',
-            '__module__',
-        ]
+        members = ['__init__', '__repr__', '__weakref__', '__dict__', '__module__']
         return True if name in members else skip
 
-    app.connect('autodoc-skip-member', skip)
+    app.connect('autodoc-skip-member', skip)