Update doc

Emory-Melody · Jul 28, 2024 · dc2a219 · dc2a219
1 parent 716cde7
commit dc2a219
Show file tree

Hide file tree

Showing 21 changed files with 322 additions and 226 deletions.
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/installation.doctree b/docs/_build/doctrees/installation.doctree
diff --git a/docs/_build/doctrees/quickstart.doctree b/docs/_build/doctrees/quickstart.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 9fc46237014b323953bec2db0824f101
+config: 4ec3bd3c41e66b7a2e925c66e399cf70
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
@@ -4,8 +4,22 @@ Welcome to GraphSlim's documentation!
 A comprehensive package for graph sparsification, coarsening and condensation based on PyG.
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
+   :caption: Installation
 
    installation
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Usage
+
    quickstart
-   packageref/index
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Package API
+
+   API/dataset
+   API/evaluation
+   API/method
+
diff --git a/docs/_build/html/_sources/installation.md.txt b/docs/_build/html/_sources/installation.md.txt
@@ -8,6 +8,6 @@ pip install graphslim
 ```shell
 git clone https://github.com/Emory-Melody/GraphSlim.git
 cd GraphSlim/graphslim
-pip install -r requirements_torch2+.txt
+pip install -r requirements.txt
 python setup.py 
 ```
diff --git a/docs/_build/html/_static/basic.css b/docs/_build/html/_static/basic.css
@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -237,10 +237,6 @@ a.headerlink {
     visibility: hidden;
 }
 
-a:visited {
-    color: #551A8B;
-}
-
 h1:hover > a.headerlink,
 h2:hover > a.headerlink,
 h3:hover > a.headerlink,

diff --git a/docs/_build/html/_static/doctools.js b/docs/_build/html/_static/doctools.js
@@ -4,7 +4,7 @@
  *
  * Base JavaScript utilities for all Sphinx HTML documentation.
  *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/docs/_build/html/_static/documentation_options.js b/docs/_build/html/_static/documentation_options.js
@@ -1,4 +1,5 @@
-const DOCUMENTATION_OPTIONS = {
+var DOCUMENTATION_OPTIONS = {
+    URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
     VERSION: '',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,

diff --git a/docs/_build/html/_static/language_data.js b/docs/_build/html/_static/language_data.js
@@ -5,15 +5,15 @@
  * This script contains the language-specific data used by searchtools.js,
  * namely the list of stopwords, stemmer, scorer and splitter.
  *
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
 
 var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
 
 
-/* Non-minified version is copied as a separate JS file, if available */
+/* Non-minified version is copied as a separate JS file, is available */
 
 /**
  * Porter Stemmer