[Test][DO NOT MERGE] Doc update

.gitignore

@@ -7,13 +7,12 @@ __pycache__
 .tmp
 .test_assets/
 build
+gh_pages_build
 *.DS_Store
 logs/
 .devcontainer/
 gigl.egg-info/
 gigl_dataflow_setup.egg-info/
-large_scale_gnn.egg-info/
-gigantic_graph_learning.egg-info/
 .python-version
 dist/
 *.egg-info/
@@ -39,8 +38,6 @@ graphlearn_torch/
 graphlearn_torch.egg-info/
 .git/
 
-do_not_open_source
-
 # Ignore downloaded fossa files.
 fossa
 fossa.bundle

Makefile

@@ -3,6 +3,7 @@ include dep_vars.env
 SHELL := /bin/bash
 CONDA_ENV_NAME=gnn
 PYTHON_VERSION=3.9
+PIP_VERSION=25.0.1
 DATE:=$(shell /bin/date "+%Y%m%d-%H%M")
 
 # GIT HASH, or empty string if not in a git repo.
@@ -37,7 +38,7 @@ get_ver_hash:
 	$(eval GIT_COMMIT=$(shell git log -1 --pretty=format:"%H"))
 
 initialize_environment:
-	conda create -y -c conda-forge --name ${CONDA_ENV_NAME} python=${PYTHON_VERSION} pip-tools
+	conda create -y -c conda-forge --name ${CONDA_ENV_NAME} python=${PYTHON_VERSION} pip=${PIP_VERSION} pip-tools
 	@echo "If conda environment was successfully installed, ensure to activate it and run \`make install_dev_deps\` or \`make install_deps\` to complete setup"
 
 clean_environment:
@@ -194,7 +195,7 @@ format_py:
 
 format_scala:
 	# We run "clean" before the formatting because otherwise some "scalafix.sbt.ScalafixFailed: NoFilesError" may get thrown after switching branches...
-	# TODO(kmonte): Once open sourced, follow up with scalafix people on this.
+	# TODO(kmonte): Once open sourced, follow up with scalafix team on this.
 	( cd scala; sbt clean scalafixAll scalafmtAll )
 	( cd scala_spark35; sbt clean scalafixAll scalafmtAll )
 
@@ -476,3 +477,7 @@ release_gigl:
 
 publish_docs:
 	@echo "This needs to be implemented"
+
+build_docs:
+	sphinx-build -M clean . gh_pages_build
+	sphinx-build -M html . gh_pages_build

README.md

@@ -11,6 +11,11 @@
   </strong>
 </p>
 
+<h2 align="center">
+  ⚠️ NOTICE ⚠️
+</h2>
+
+
 <h2 align="center">
 </h2>
 
@@ -49,15 +54,12 @@ The components are as follows:
 
 | Component | Source Code | Documentation |
 |-------------------|---------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|
-| Config Populator | [here](python/gigl/src/config_populator/config_populator.py) |
-[here](docs/sphinx/source/components/config_populator.md) | | Data Preprocessor |
-[here](python/gigl/src/data_preprocessor/data_preprocessor.py) |
-[here](docs/sphinx/source/components/data_preprocessor.md) | | Subgraph Sampler |
-[here](scala/subgraph_sampler/src/main/scala/Main.scala) | [here](docs/sphinx/source/components/subgraph_sampler.md) | |
-Split Generator | [here](scala/split_generator/src/main/scala/Main.scala) |
-[here](docs/sphinx/source/components/split_generator.md) | | Trainer | [here](python/gigl/src/training/trainer.py) |
-[here](docs/sphinx/source/components/trainer.md) | | Inferencer | [here](python/gigl/src/inference/gnn_inferencer.py) |
-[here](docs/sphinx/source/components/inferencer.md) |
+| Config Populator | [here](python/gigl/src/config_populator/config_populator.py) | [here](docs/sphinx/source/components/config_populator.md) |
+| Data Preprocessor | [here](python/gigl/src/data_preprocessor/data_preprocessor.py) | [here](docs/sphinx/source/components/data_preprocessor.md) |
+| Subgraph Sampler | [here](scala/subgraph_sampler/src/main/scala/Main.scala) | [here](docs/sphinx/source/components/subgraph_sampler.md) |
+| Split Generator | [here](scala/split_generator/src/main/scala/Main.scala) | [here](docs/sphinx/source/components/split_generator.md) |
+| Trainer | [here](python/gigl/src/training/trainer.py) | [here](docs/sphinx/source/components/trainer.md) |
+| Inferencer | [here](python/gigl/src/inference/gnn_inferencer.py) | [here](docs/sphinx/source/components/inferencer.md) |
 
 The figure below illustrates at a high level how all the components work together for and end-to-end GiGL pipeline.
 

conf.py

@@ -0,0 +1,65 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+import pathlib
+
+curr_file_dir = pathlib.Path(__file__).parent.resolve()
+
+project = 'GiGL'
+copyright = '2025, Snap Inc'
+author = 'Snap Inc'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+
+# https://www.sphinx-doc.org/en/master/usage/extensions/index.html
+extensions = [
+    "sphinx.ext.autodoc",  # Pull in documentation from docstrings
+    "sphinx.ext.autosummary", # Generates function/method/attribute summary lists
+    "myst_parser", # Parsing markdown files: https://myst-parser.readthedocs.io/en/v0.15.1/sphinx/intro.html
+    "sphinx_design", # needed by themes
+]
+
+myst_enable_extensions = [
+    "html_image", # Convert <img> tags in markdown files; https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#html-images
+]
+
+include_patterns = [
+    "docs/**",
+    "python/**",
+    "snapchat/**",
+    "index.rst",
+]
+
+
+templates_path = [
+    'gh_pages_source/_templates'
+]
+html_static_path = [
+    'gh_pages_source/_static',
+]
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+html_theme = "pydata_sphinx_theme" # https://pydata-sphinx-theme.readthedocs.io/en/stable/
+html_logo = "docs/assets/images/gigl.png"
+html_theme_options = {
+    # https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/header-links.html#icon-links
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/Snapchat/GiGL",
+            "icon": "fa-brands fa-github",
+        }
+    ],
+    "logo": {
+        "text": "GiGL",
+        "image_dark": "docs/assets/images/gigl.png",
+    }
+}

docs/api_reference/index.rst

@@ -0,0 +1,14 @@
+.. This file contains instructions to autogenerate API documentation using Sphinx.
+.. See: `conf.py` for configuration options.
+
+=============
+API Reference
+=============
+
+.. autosummary::
+   :toctree: _autosummary
+   :template: module.rst
+   :recursive:
+
+   gigl
+   snapchat