Create API docs

CONTRIBUTING.md

@@ -54,7 +54,7 @@ Run before each commit: `bandit -r numba_dppy -lll`
 
 Install Sphinx and plugins:
 ```bash
-pip install sphinx autodoc recommonmark sphinx-rtd-theme
+pip install sphinx autodoc recommonmark sphinx-rtd-theme sphinxcontrib-apidoc
 ```
 
 Generate HTML:

docs/.gitignore

@@ -0,0 +1 @@
+apidoc

docs/conf.py

@@ -36,6 +36,7 @@
     "sphinx_rtd_theme",
     "sphinx.ext.autodoc",
     "sphinx.ext.todo",
+    "sphinxcontrib.apidoc",
 ]
 
 todo_include_todos = True
@@ -62,3 +63,11 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
+
+modindex_common_prefix = ["numba_dppy."]
+
+# See https://github.com/sphinx-contrib/apidoc
+apidoc_module_dir = "../numba_dppy"
+apidoc_output_dir = "apidoc"
+apidoc_excluded_paths = ["tests"]
+apidoc_separate_modules = True

docs/index.rst

@@ -91,3 +91,17 @@ Numba-dppy is Licensed under Apache License 2.0 that can be found in
 `LICENSE <https://github.com/IntelPython/numba-dppy/blob/main/LICENSE>`_.
 All usage and contributions to the project are subject to the terms and
 conditions of this license.
+
+
+Indices and tables
+==================
+
+.. only:: builder_html
+
+   * :ref:`genindex`
+   * :ref:`modindex`
+   * :ref:`search`
+
+.. only:: not builder_html
+
+   * :ref:`modindex`

docs/user_guides/kernel_programming_guide/device-functions.rst

@@ -14,7 +14,7 @@ specifically to implement device functions.
 To use a device function from an another device function:
 
 .. literalinclude:: ../../../numba_dppy/examples/dppy_func.py
-   :pyobject: an_another_device_function
+   :pyobject: another_device_function
 
 To use a device function from a kernel function ``numba_dppy.kernel``: