📝 Doc build working now

.readthedocs.yaml

@@ -13,7 +13,7 @@ build:
 
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:
-   configuration: docs/conf.py
+   configuration: docs/source/conf.py
 
 # Optional but recommended, declare the Python requirements required
 # to build your documentation

docs/source/conf.py

@@ -1,65 +1,50 @@
 # Configuration file for the Sphinx documentation builder.
 #
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
+# For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-# -- Path setup --------------------------------------------------------------
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-# import os
+import sphinx_rtd_theme
+import os
 import sys
-import pathlib
 
-# sys.path.insert(0, os.path.abspath('.'))
-sys.path.insert(0, pathlib.Path(__file__).parents[2].resolve().as_posix())
+# Temporary fix to ensure that the stgraph codebase can be accessed
+sys.path.insert(0, os.path.abspath("../../stgraph"))
 
+html_theme = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
-# -- Project information -----------------------------------------------------
-
-project = "STGraph"
-copyright = "2023, Nithin Puthalath Manoj, Joel Mathew Cherian"
-author = "Nithin Puthalath Manoj, Joel Mathew Cherian"
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]
+html_logo = "_static/STGraph_docs_logo.png"
+html_theme_options = {
+    "logo_only": True,
+    "display_version": False,
+}
 
-# The full version, including alpha/beta/rc tags
-release = "1.0.0"
+html_css_files = ["custom.css"]
 
+project = "STGraph"
+copyright = "2024, Joel Mathew Cherian, Nithin Puthalath Manoj"
+author = "Joel Mathew Cherian, Nithin Puthalath Manoj"
+release = "1.1.0"
 
 # -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
 extensions = [
     "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    'sphinx.ext.intersphinx',
     "sphinx.ext.autosummary",
-    "sphinx.ext.napoleon",
+    "sphinx.ext.napoleon"
 ]
 
-# Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 
 # -- Options for HTML output -------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
-html_theme = "sphinx_rtd_theme"
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
-
-html_css_files = [
-    'custom.css',
-]
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

docs/source/generated/modules.rst

@@ -0,0 +1,7 @@
+stgraph
+=======
+
+.. toctree::
+   :maxdepth: 4
+
+   stgraph

docs/source/generated/stgraph.compiler.backend.mxnet.rst

@@ -0,0 +1,10 @@
+stgraph.compiler.backend.mxnet package
+======================================
+
+Module contents
+---------------
+
+.. automodule:: stgraph.compiler.backend.mxnet
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/generated/stgraph.compiler.backend.pytorch.rst

@@ -0,0 +1,29 @@
+stgraph.compiler.backend.pytorch package
+========================================
+
+Submodules
+----------
+
+stgraph.compiler.backend.pytorch.torch\_callback module
+-------------------------------------------------------
+
+.. automodule:: stgraph.compiler.backend.pytorch.torch_callback
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+stgraph.compiler.backend.pytorch.torch\_kernel\_wrapper module
+--------------------------------------------------------------
+
+.. automodule:: stgraph.compiler.backend.pytorch.torch_kernel_wrapper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: stgraph.compiler.backend.pytorch
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/generated/stgraph.compiler.backend.rst

@@ -0,0 +1,39 @@
+stgraph.compiler.backend package
+================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   stgraph.compiler.backend.mxnet
+   stgraph.compiler.backend.pytorch
+   stgraph.compiler.backend.tensorflow
+
+Submodules
+----------
+
+stgraph.compiler.backend.callback module
+----------------------------------------
+
+.. automodule:: stgraph.compiler.backend.callback
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+stgraph.compiler.backend.kernel\_wrapper module
+-----------------------------------------------
+
+.. automodule:: stgraph.compiler.backend.kernel_wrapper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: stgraph.compiler.backend
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/generated/stgraph.compiler.backend.tensorflow.rst

@@ -0,0 +1,10 @@
+stgraph.compiler.backend.tensorflow package
+===========================================
+
+Module contents
+---------------
+
+.. automodule:: stgraph.compiler.backend.tensorflow
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/generated/stgraph.compiler.code_gen.rst

@@ -0,0 +1,77 @@
+stgraph.compiler.code\_gen package
+==================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   stgraph.compiler.code_gen.templates
+
+Submodules
+----------
+
+stgraph.compiler.code\_gen.code\_gen module
+-------------------------------------------
+
+.. automodule:: stgraph.compiler.code_gen.code_gen
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+stgraph.compiler.code\_gen.compiler module
+------------------------------------------
+
+.. automodule:: stgraph.compiler.code_gen.compiler
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+stgraph.compiler.code\_gen.cuda\_check module
+---------------------------------------------
+
+.. automodule:: stgraph.compiler.code_gen.cuda_check
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+stgraph.compiler.code\_gen.cuda\_driver module
+----------------------------------------------
+
+.. automodule:: stgraph.compiler.code_gen.cuda_driver
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+stgraph.compiler.code\_gen.cuda\_error module
+---------------------------------------------
+
+.. automodule:: stgraph.compiler.code_gen.cuda_error
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+stgraph.compiler.code\_gen.device\_info module
+----------------------------------------------
+
+.. automodule:: stgraph.compiler.code_gen.device_info
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+stgraph.compiler.code\_gen.kernel\_context module
+-------------------------------------------------
+
+.. automodule:: stgraph.compiler.code_gen.kernel_context
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: stgraph.compiler.code_gen
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/generated/stgraph.compiler.code_gen.templates.fa.rst

@@ -0,0 +1,10 @@
+stgraph.compiler.code\_gen.templates.fa package
+===============================================
+
+Module contents
+---------------
+
+.. automodule:: stgraph.compiler.code_gen.templates.fa
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/generated/stgraph.compiler.code_gen.templates.rst

@@ -0,0 +1,19 @@
+stgraph.compiler.code\_gen.templates package
+============================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   stgraph.compiler.code_gen.templates.fa
+   stgraph.compiler.code_gen.templates.v2
+
+Module contents
+---------------
+
+.. automodule:: stgraph.compiler.code_gen.templates
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/generated/stgraph.compiler.code_gen.templates.v2.rst

@@ -0,0 +1,10 @@
+stgraph.compiler.code\_gen.templates.v2 package
+===============================================
+
+Module contents
+---------------
+
+.. automodule:: stgraph.compiler.code_gen.templates.v2
+   :members:
+   :undoc-members:
+   :show-inheritance: