docs

Author: SherylHYX

docs/Makefile

@@ -5,7 +5,7 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
+SOURCEDIR     = source
 BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".

docs/make.bat

@@ -7,7 +7,7 @@ REM Command file for Sphinx documentation
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
-set SOURCEDIR=.
+set SOURCEDIR=source
 set BUILDDIR=_build
 
 if "%1" == "" goto help

docs/source/_static/css/custom.css

@@ -3,11 +3,77 @@
   background-color: #fff;
 }
 
+.wy-side-nav-search > a,
+.wy-side-nav-search .wy-dropdown > a {
+  display: block;
+  margin: 0 auto;
+}
+
+.wy-side-nav-search img.logo {
+  max-width: 240px;
+  width: 100%;
+  height: auto;
+  margin: 0 auto 0.4rem auto;
+}
+
 .wy-side-nav-search > div.version {
   color: #000;
 }
 
-/* Justify the text. */
+/* Match the cleaner reading width used by polished RTD docs. */
+.wy-nav-content {
+  max-width: 980px;
+}
+
+.wy-nav-content-wrap {
+  background: #fcfcfd;
+}
+
+.wy-nav-content {
+  box-shadow: 0 1px 3px rgba(0, 0, 0, 0.04);
+}
+
+.rst-content {
+  line-height: 1.65;
+}
+
+.rst-content h1 {
+  margin-bottom: 0.3em;
+}
+
+.rst-content h2,
+.rst-content h3 {
+  margin-top: 1.4em;
+}
+
+.rst-content p {
+  margin-bottom: 0.9em;
+}
+
+.rst-content table.docutils {
+  border-radius: 6px;
+  overflow: hidden;
+}
+
+.rst-content table.docutils thead th {
+  background: #f2f5f9;
+}
+
+.wy-menu-vertical header,
+.wy-menu-vertical p.caption {
+  color: #4a5568;
+  letter-spacing: 0.02em;
+}
+
+.wy-menu-vertical li.current > a {
+  font-weight: 600;
+}
+
+/* Keep tables and code blocks inside the content area on narrow screens. */
+.wy-table-responsive table td,
+.wy-table-responsive table th {
+  white-space: normal;
+}
 
 .section #basic-2-flip-flop-synchronizer{
      text-align:justify;

docs/source/conf.py

@@ -2,8 +2,6 @@
 import os
 import sys
 
-import sphinx_rtd_theme
-
 sys.path.insert(0, os.path.abspath('../../'))
 
 project = 'PyTorch Geometric Signed Directed'
@@ -23,17 +21,15 @@
 source_suffix = '.rst'
 
 html_theme = 'sphinx_rtd_theme'
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 html_theme_options = {
-    "collapse_navigation": True,
-    "display_version": True,
-    "logo_only": False,
+    "collapse_navigation": False,
+    "logo_only": True,
     "navigation_depth": 2,
 }
 
 html_logo = '_static/img/text_logo.jpg'
 html_static_path = ['_static']
-html_context = {'css_files': ['_static/css/custom.css']}
+html_css_files = ['css/custom.css']
 
 intersphinx_mapping = {
     'python': ('https://docs.python.org/3', None),

docs/source/index.rst

@@ -3,23 +3,66 @@ PyTorch Geometric Signed Directed
 
 PyTorch Geometric Signed Directed provides graph neural network models for signed and directed graphs built on PyTorch Geometric.
 
-Quick Links
------------
-
 .. toctree::
-   :maxdepth: 1
-   :caption: Getting Started
+   :maxdepth: 2
+   :hidden:
 
    notes/installation
    notes/introduction
    notes/datasets
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Reference
-
    notes/case_study
    notes/resources
    modules/model
    modules/data
-   modules/utils
+   modules/utils
+
+Getting Started
+---------------
+
+.. list-table::
+   :widths: 28 72
+   :header-rows: 1
+
+   * - Guide
+     - Summary
+
+   * - :doc:`Installation <notes/installation>`
+     - Set up prerequisites and install the package.
+
+   * - :doc:`Introduction <notes/introduction>`
+     - Learn the core concepts, data classes, and citation details.
+
+   * - :doc:`Datasets <notes/datasets>`
+     - Explore supported directed and signed real-world datasets.
+
+Documentation
+-------------
+
+.. list-table::
+   :widths: 28 72
+   :header-rows: 1
+
+   * - Section
+     - Summary
+
+   * - :doc:`Case Study Examples <notes/case_study>`
+     - End-to-end examples for signed and directed tasks.
+
+   * - :doc:`External Resources <notes/resources>`
+     - Papers and reference implementations used by the library.
+
+   * - :doc:`Models API <modules/model>`
+     - Directed and signed model and layer documentation.
+
+   * - :doc:`Data API <modules/data>`
+     - Data classes, generators, and loaders.
+
+   * - :doc:`Utils API <modules/utils>`
+     - Objective functions, metrics, and utility helpers.
+
+Indices and Tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`