Skip to content

Commit f930806

Browse files
author
Diptorup Deb
committed
Publish API docs for more modules.
1 parent 0bcc50a commit f930806

File tree

3 files changed

+18
-18
lines changed

3 files changed

+18
-18
lines changed

docs/_templates/autoapi/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ This page contains auto-generated API reference documentation [#f1]_.
77
:maxdepth: 2
88

99
numba_dpex/kernel_api/index
10+
numba_dpex/experimental/decorators/index
11+
numba_dpex/experimental/launcher/index
1012

1113
{% for page in pages %}
1214
{% if page.top_level_object and page.display %}

docs/source/conf.py

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -113,19 +113,10 @@
113113

114114
# -- Auto API configurations ---------------------------------------------------
115115

116-
117-
# def skip_util_classes(app, what, name, obj, skip, options):
118-
# if what == "module" and "experimental" in name:
119-
# if what == "module" and "decorators" not in name:
120-
# skip = True
121-
# return skip
122-
123-
124-
# def setup(sphinx):
125-
# sphinx.connect("autoapi-skip-member", skip_util_classes)
126-
127-
128-
autoapi_dirs = ["../../numba_dpex/kernel_api"]
116+
autoapi_dirs = [
117+
"../../numba_dpex/kernel_api",
118+
"../../numba_dpex/experimental",
119+
]
129120
autoapi_type = "python"
130121

131122
autoapi_template_dir = "_templates/autoapi"
@@ -159,3 +150,14 @@ def prepare_jinja_env(jinja_env) -> None:
159150

160151

161152
autoapi_prepare_jinja_env = prepare_jinja_env
153+
154+
155+
def skip_member(app, what, name, obj, skip, options):
156+
# skip submodules
157+
if what == "module":
158+
skip = True
159+
return skip
160+
161+
162+
def setup(sphinx):
163+
sphinx.connect("autoapi-skip-member", skip_member)

docs/source/programming_model.rst

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -228,11 +228,7 @@ For example, consider
228228

229229
.. code:: python
230230
231-
# Use usm_type = 'device' to get USM-device allocation (default),
232-
# usm_type = 'shared' to get USM-shared allocation,
233-
# usm_type = 'host' to get USM-host allocation
234-
def dpt.empty(..., device=None, usm_type=None, sycl_queue=None) -> dpctl.tensor.usm_ndarray:
235-
...
231+
# TODO
236232
237233
The keyword ``device`` is `mandated by the array API
238234
<https://data-apis.org/array-api/latest/design_topics/device_support.html#syntax-for-device-assignment>`__.

0 commit comments

Comments
 (0)