|
5 | 5 | # coding: utf-8
|
6 | 6 | # Configuration file for the Sphinx documentation builder.
|
7 | 7 |
|
8 |
| -# -- Project information ----------------------------------------------------- |
| 8 | +# -- Project information ------------------------------------------------------- |
9 | 9 |
|
10 | 10 | import sys
|
11 | 11 |
|
| 12 | +import numba_dpex |
| 13 | + |
12 | 14 | sys.path.append(".")
|
13 | 15 |
|
14 | 16 | from sycl_spec_links import sycl_ext_links # noqa E402
|
|
18 | 20 | author = "Intel Corporation"
|
19 | 21 |
|
20 | 22 | # The full version, including alpha/beta/rc tags
|
21 |
| -# release = "main" |
| 23 | +release = numba_dpex.__version__ |
22 | 24 |
|
23 |
| -# -- General configuration ---------------------------------------------------- |
| 25 | +# -- General configuration ----------------------------------------------------- |
24 | 26 |
|
25 | 27 | # Add any Sphinx extension module names here, as strings. They can be
|
26 | 28 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
51 | 53 | extlinks = {}
|
52 | 54 | extlinks.update(sycl_ext_links)
|
53 | 55 |
|
54 |
| -# -- Options for HTML output ------------------------------------------------- |
| 56 | +# -- Options for HTML output --------------------------------------------------- |
55 | 57 |
|
56 | 58 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
57 | 59 | # a list of builtin themes.
|
58 | 60 | #
|
59 |
| -# html_theme = "pydata_sphinx_theme" |
60 | 61 | html_theme = "furo"
|
61 | 62 |
|
62 | 63 | html_theme_options = {
|
|
81 | 82 |
|
82 | 83 | html_show_sourcelink = False
|
83 | 84 |
|
84 |
| -# -- Todo extension configuration ---------------------------------------------- |
| 85 | +# -- Todo extension configuration --------------------------------------------- |
85 | 86 | todo_include_todos = True
|
86 | 87 | todo_link_only = True
|
87 | 88 |
|
88 | 89 | # -- InterSphinx configuration: looks for objects in external projects -----
|
89 | 90 | intersphinx_mapping = {}
|
90 | 91 |
|
91 | 92 |
|
92 |
| -# -- Prepend module name to an object name or not ----------------------------------- |
| 93 | +# -- Prepend module name to an object name or not ------------------------------ |
93 | 94 | add_module_names = False
|
94 | 95 |
|
| 96 | + |
| 97 | +# -- autodoc configurations ---------------------------------------------------- |
| 98 | + |
| 99 | +autodoc_typehints_format = "short" |
| 100 | +python_use_unqualified_type_names = True |
| 101 | + |
95 | 102 | # -- Auto API configurations ---------------------------------------------------
|
96 | 103 |
|
97 | 104 | autoapi_dirs = [
|
|
0 commit comments