Update conf.py

rapidsai · May 17, 2022 · 58a77d8 · 58a77d8
1 parent 2a32923
commit 58a77d8
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/docs/cudf/source/conf.py b/docs/cudf/source/conf.py
@@ -238,6 +238,9 @@ def resolve_aliases(app, doctree):
 def ignore_internal_references(app, env, node, contnode):
     name = node.get("reftarget", None)
     if name == "cudf.core.index.GenericIndex":
+        # We don't exposed docs for `cudf.core.index.GenericIndex`
+        # hence we would want the docstring & mypy references to
+        # use `cudf.Index`
         node["reftarget"] = "cudf.Index"
         return contnode
     elif name is not None and name in _internal_names_to_ignore: