Skip to content

Commit 02d9d5a

Browse files
author
Diptorup Deb
committed
Edits to documentation configuration.
- Use autodoc settings to shorten the type hint displayed on API documentation. - Display version number for which documentation was generated.
1 parent 0157488 commit 02d9d5a

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

docs/source/conf.py

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,12 @@
55
# coding: utf-8
66
# Configuration file for the Sphinx documentation builder.
77

8-
# -- Project information -----------------------------------------------------
8+
# -- Project information -------------------------------------------------------
99

1010
import sys
1111

12+
import numba_dpex
13+
1214
sys.path.append(".")
1315

1416
from sycl_spec_links import sycl_ext_links # noqa E402
@@ -18,9 +20,9 @@
1820
author = "Intel Corporation"
1921

2022
# The full version, including alpha/beta/rc tags
21-
# release = "main"
23+
release = numba_dpex.__version__
2224

23-
# -- General configuration ----------------------------------------------------
25+
# -- General configuration -----------------------------------------------------
2426

2527
# Add any Sphinx extension module names here, as strings. They can be
2628
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -51,12 +53,11 @@
5153
extlinks = {}
5254
extlinks.update(sycl_ext_links)
5355

54-
# -- Options for HTML output -------------------------------------------------
56+
# -- Options for HTML output ---------------------------------------------------
5557

5658
# The theme to use for HTML and HTML Help pages. See the documentation for
5759
# a list of builtin themes.
5860
#
59-
# html_theme = "pydata_sphinx_theme"
6061
html_theme = "furo"
6162

6263
html_theme_options = {
@@ -81,17 +82,23 @@
8182

8283
html_show_sourcelink = False
8384

84-
# -- Todo extension configuration ----------------------------------------------
85+
# -- Todo extension configuration ---------------------------------------------
8586
todo_include_todos = True
8687
todo_link_only = True
8788

8889
# -- InterSphinx configuration: looks for objects in external projects -----
8990
intersphinx_mapping = {}
9091

9192

92-
# -- Prepend module name to an object name or not -----------------------------------
93+
# -- Prepend module name to an object name or not ------------------------------
9394
add_module_names = False
9495

96+
97+
# -- autodoc configurations ----------------------------------------------------
98+
99+
autodoc_typehints_format = "short"
100+
python_use_unqualified_type_names = True
101+
95102
# -- Auto API configurations ---------------------------------------------------
96103

97104
autoapi_dirs = [

0 commit comments

Comments
 (0)