Generate API docs for kernel_api

IntelPython · Feb 14, 2024 · 84bfa04 · 84bfa04
1 parent f9467d3
commit 84bfa04
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 11 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -1,2 +1,3 @@
 apidoc
 sources/_build
+source/autoapi
diff --git a/docs/Makefile b/docs/Makefile
@@ -7,6 +7,7 @@ SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = ./source
 BUILDDIR      = _build
+AUTOAPIDIR    = source/autoapi
 
 # Put it first so that "make" without argument is like "make help".
 help:
@@ -20,4 +21,4 @@ help:
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 clean:
-	rm -rf "$(BUILDDIR)"
+	rm -rf "$(BUILDDIR)" "$(AUTOAPIDIR)"
diff --git a/docs/_templates/autoapi/index.rst b/docs/_templates/autoapi/index.rst
@@ -4,7 +4,9 @@ API Reference
 This page contains auto-generated API reference documentation [#f1]_.
 
 .. toctree::
-   :titlesonly:
+   :maxdepth: 2
+
+   numba_dpex/kernel_api/index
 
    {% for page in pages %}
    {% if page.top_level_object and page.display %}

diff --git a/docs/source/api_reference/index.rst b/docs/source/api_reference/index.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -119,7 +119,20 @@
 add_module_names = False
 
 # -- Auto API configurations ---------------------------------------------------
-autoapi_dirs = ["../numba_dpex/kernel_api"]
+
+
+# def skip_util_classes(app, what, name, obj, skip, options):
+#     if what == "module" and "experimental" in name:
+#         if what == "module" and "decorators" not in name:
+#             skip = True
+#     return skip
+
+
+# def setup(sphinx):
+#     sphinx.connect("autoapi-skip-member", skip_util_classes)
+
+
+autoapi_dirs = ["../../numba_dpex/kernel_api"]
 autoapi_type = "python"
 
 autoapi_template_dir = "_templates/autoapi"