docs: fix build issues and add sub-sections (#69)

docs/axonn_style.py

@@ -0,0 +1,16 @@
+# Copyright 2024 Parallel Software and Systems Group, University of Maryland.
+# See the top-level LICENSE file for details.
+#
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+# The name of the Pygments (syntax highlighting) style to use.
+from pygments.styles.default import DefaultStyle
+from pygments.token import Generic
+
+
+# modifications to the default style
+class AxonnStyle(DefaultStyle):
+    styles = DefaultStyle.styles.copy()
+    background_color = "#f4f4f8"
+    styles[Generic.Output] = "#355"
+    styles[Generic.Prompt] = "bold #346ec9"

docs/conf.py

@@ -15,15 +15,11 @@
 # 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 os
 import sys
 
 # sys.path.insert(0, os.path.abspath('.'))
 
-# The name of the Pygments (syntax highlighting) style to use.
-from pygments.styles.default import DefaultStyle
-from pygments.token import Generic
-
 import pkg_resources
 
 
@@ -60,21 +56,14 @@
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 
-# modifications to the default style
-class AxonnStyle(DefaultStyle):
-    styles = DefaultStyle.styles.copy()
-    background_color = "#f4f4f8"
-    styles[Generic.Output] = "#355"
-    styles[Generic.Prompt] = "bold #346ec9"
-
-
 dist = pkg_resources.Distribution(__file__)
 sys.path.append(".")  # make 'conf' module findable
 ep = pkg_resources.EntryPoint.parse("axonn = conf:AxonnStyle", dist=dist)
 dist._ep_map = {"pygments.styles": {"plugin1": ep}}
 pkg_resources.working_set.add(dist)
 
-pygments_style = "axonn"
+sys.path.insert(0, os.path.abspath("."))
+pygments_style = "axonn_style.AxonnStyle"
 
 
 # -- Options for HTML output -------------------------------------------------

docs/examples.rst

@@ -0,0 +1,17 @@
+
+********
+Examples
+********
+
+Training
+============
+
+
+
+Fine-tuning
+===========
+
+
+
+Inference
+=========

docs/index.rst

@@ -19,6 +19,9 @@ AxoNN is a parallel framework for training deep neural networks.
    :caption: User Docs
 
    getting_started
+   user_guide
+   examples
+
 
 
 ##################

docs/user_guide.rst

@@ -0,0 +1,28 @@
+**********
+User Guide
+**********
+
+Initializing AxoNN
+==================
+
+Tensor with Easy API
+====================
+
+Tensor using Advanced API
+=====================================
+
+Combining Tensor in AxoNN with PyTorch DDP
+==========================================
+
+Integration with other Parallel APIs
+====================================
+
+Huggingface
+-----------
+
+Pipelining in AxoNN 
+===================
+
+Combining Pipelining in AxoNN with Data Parallelism 
+===================================================
+