python doc auto generation (#605)

Add Python API references

docs/.gitignore

@@ -1,2 +1,3 @@
 doxygen/
 _build/
+py_api/

docs/conf.py

@@ -14,7 +14,36 @@ release = "v0.7.0"
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ["breathe", "myst_parser", "sphinxcontrib.mermaid"]
+import os, sys
+
+sys.path.insert(0, os.path.abspath("../python"))
+
+extensions = [
+    "breathe",
+    "myst_parser",
+    "sphinxcontrib.mermaid",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.intersphinx",
+    "sphinx_autodoc_typehints",
+]
+
+autosummary_generate = True
+autodoc_default_options = {
+    "members": True,
+    "inherited-members": True,
+    "show-inheritance": True,
+}
+# only mock the C-extension when using the source tree
+autodoc_mock_imports = ["mscclpp._mscclpp", "sortedcontainers"]
+autodoc_typehints = "description"
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "numpy": ("https://numpy.org/doc/stable/", None),
+}
 
 templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

docs/index.rst

@@ -23,3 +23,4 @@ You can find the followings from this documentation.
    tutorials
    programming_guide
    cpp_api
+   py_api

docs/programming_guide.rst

@@ -11,3 +11,4 @@ This section provides advanced topics and best practices for using MSCCL++. It i
    guide/memory-management
    guide/advanced-connections
    guide/cpp-examples
+   guide/mscclpp-dsl

docs/py_api.rst

@@ -0,0 +1,10 @@
+Python API Reference
+====================
+
+This reference organizes the MSCCL++ Python API.
+
+.. autosummary::
+   :toctree: py_api
+   :recursive:
+
+   mscclpp

docs/quickstart.md

@@ -177,8 +177,6 @@ mpirun -np 8 --bind-to numa --allow-run-as-root -x LD_PRELOAD=$MSCCLPP_BUILD/app
 
 If MSCCL++ is built on AMD platforms, `libmscclpp_nccl.so` would replace the [RCCL](https://github.com/ROCm/rccl) library (i.e., `librccl.so`).
 
-See limitations of the current NCCL over MSCCL++ from [here](design/nccl-over-mscclpp.md#limitations).
-
 MSCCL++ also supports fallback to NCCL/RCCL collectives by adding following environment variables.
 ```bash
 -x MSCCLPP_ENABLE_NCCL_FALLBACK=TRUE

docs/requirements.txt

@@ -2,3 +2,4 @@ breathe
 sphinx_rtd_theme
 myst_parser
 sphinxcontrib-mermaid
+sphinx-autodoc-typehints

python/mscclpp/__init__.py

@@ -1,6 +1,8 @@
 # Copyright (c) Microsoft Corporation.
 # Licensed under the MIT license.
 
+"""MSCCL++ Python API."""
+
 import os
 import warnings
 from functools import wraps

python/mscclpp/language/__init__.py

@@ -0,0 +1,4 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+"""MSCCL++ DSL."""