Integrate dpnp.tensor docs to dpnp

doc/_templates/autosummary/cython_class.rst

@@ -0,0 +1,29 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ name }}
+   {% block methods %}
+
+   {% if methods %}
+   .. rubric:: {{ _('Methods') }}
+
+   .. autosummary::
+      :toctree: generated
+   {% for item in methods if item != "__init__" %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: {{ _('Attributes') }}
+
+   .. autosummary::
+      :toctree: generated
+   {% for item in attributes %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}

doc/_templates/autosummary/elementwise.rst

@@ -0,0 +1,12 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+{% if objtype == "data" %}
+.. auto{{ objtype }}:: {{ objname }}
+    :no-value:
+{% endif %}
+
+{% if objtype == "function" %}
+.. auto{{ objtype }}:: {{ objname }}
+{% endif %}

doc/_templates/autosummary/usm_ndarray.rst

@@ -0,0 +1,48 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+
+
+.. autoclass:: {{ name }}
+
+   {% block methods %}
+
+   {% if methods %}
+   .. rubric:: {{ _('Methods') }}
+
+   .. autosummary::
+      :toctree: generated
+      :nosignatures:
+   {% for item in methods if item != "__init__" %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: {{ _('Attributes') }}
+
+   .. autosummary::
+      :toctree: generated
+      :nosignatures:
+   {% for item in attributes %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+
+   .. rubric:: {{ _('Special attributes') }}
+
+   .. autosummary::
+      :toctree: generated
+      :nosignatures:
+
+      ~{{name}}.__dlpack_device__
+      ~{{name}}.__dlpack__
+      ~{{name}}.__sycl_usm_array_interface__
+      ~{{name}}._pointer
+      ~{{name}}._element_offset
+      ~{{name}}._byte_bounds
+
+   {% endif %}
+   {% endblock %}

doc/conf.py

@@ -6,7 +6,6 @@
 # http://www.sphinx-doc.org/en/master/config
 
 from datetime import datetime
-from urllib.parse import urljoin
 
 from sphinx.ext.autodoc import FunctionDocumenter
 from sphinx.ext.napoleon import NumpyDocstring, docstring
@@ -235,9 +234,6 @@ def _can_document_member(member, *args, **kwargs):
 
 autosummary_generate = True
 
-_DPCTL_021_BASE = "https://intelpython.github.io/dpctl/0.21.1/"
-_DPCTL_021_INV = urljoin(_DPCTL_021_BASE, "objects.inv")
-
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3/", None),
     "numpy": ("https://numpy.org/doc/stable/", None),
@@ -309,65 +305,3 @@ def _parse_returns_section_patched(self, section: str) -> list[str]:
 
 
 NumpyDocstring._parse_returns_section = _parse_returns_section_patched
-
-
-# TODO: Remove once dpnp.tensor docs are generated in dpnp
-def _load_dpctl_tensor_inventory(app):
-    """Load dpctl 0.21.1 inventory for dpnp.tensor fallback only."""
-    from sphinx.ext.intersphinx import fetch_inventory
-    from sphinx.util import logging
-
-    logger = logging.getLogger(__name__)
-
-    try:
-        inv = fetch_inventory(app, _DPCTL_021_BASE, _DPCTL_021_INV)
-    except Exception as exc:
-        logger.warning(
-            "Failed to load dpctl 0.21.1 inventory from %s: %s",
-            _DPCTL_021_INV,
-            exc,
-        )
-        inv = {}
-
-    app.builder.env._dpctl_tensor_021_inventory = inv
-
-
-# TODO: Remove once dpnp.tensor docs are generated in dpnp
-def _resolve_dpnp_tensor_refs(app, env, node, contnode):
-    """Resolve dpnp.tensor.* references to dpctl 0.21.1 documentation.
-
-    This temporary workaround is needed because dpnp.tensor documentation
-    is not generated yet, while the corresponding API is still documented
-    in dpctl 0.21.1.
-    """
-    from docutils import nodes as docutils_nodes
-
-    target = node.get("reftarget", "")
-    if not target.startswith("dpnp.tensor"):
-        return None
-
-    dpctl_target = target.replace("dpnp.tensor", "dpctl.tensor", 1)
-    dpctl_tensor_inv = getattr(env, "_dpctl_tensor_021_inventory", {})
-
-    for _objtype, objects in dpctl_tensor_inv.items():
-        if dpctl_target not in objects:
-            continue
-
-        item = objects[dpctl_target]
-        location = item.uri
-        if location.endswith("$"):
-            location = location[:-1] + dpctl_target
-
-        refuri = urljoin(_DPCTL_021_BASE, location)
-        newnode = docutils_nodes.reference(
-            "", "", internal=False, refuri=refuri
-        )
-        newnode += contnode.deepcopy()
-        return newnode
-
-    return None
-
-
-def setup(app):
-    app.connect("builder-inited", _load_dpctl_tensor_inventory, priority=400)
-    app.connect("missing-reference", _resolve_dpnp_tensor_refs, priority=400)

doc/index.rst

@@ -82,6 +82,7 @@ core `NumPy*`_ functions and numerical data types.
 
    overview
    quick_start_guide
+   user_guides/index
    reference/index
    tensor
    dpnp_backend_api

doc/reference/index.rst

@@ -13,6 +13,7 @@ API reference of the Data Parallel Extension for NumPy*
 .. toctree::
    :maxdepth: 2
 
+   tensor
    ndarray
    ufunc
    routines

doc/reference/tensor.accumulation_functions.rst

@@ -0,0 +1,16 @@
+.. _dpnp_tensor_accumulation_functions:
+
+Accumulation functions
+======================
+
+Accumulation functions compute cumulative results along a given axis of the input array.
+
+.. currentmodule:: dpnp.tensor
+
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    cumulative_logsumexp
+    cumulative_prod
+    cumulative_sum

doc/reference/tensor.constants.rst

@@ -0,0 +1,35 @@
+.. _dpnp_tensor_constants:
+
+Constants
+=========
+
+The following constants are defined in :py:mod:`dpnp.tensor`:
+
+.. currentmodule:: dpnp.tensor
+
+.. autodata:: DLDeviceType
+
+.. data:: e
+
+   ``float``:
+        IEEE 754 floating-point representation of Euler's constant.
+
+.. data:: inf
+
+   ``float``:
+        IEEE 754 floating-point representation of (positive) infinity.
+
+.. data:: nan
+
+   ``float``:
+        IEEE 754 floating-point representation of Not a Number (NaN).
+
+.. data:: newaxis
+
+   ``NoneType``:
+        Alias for ``None`` which is useful for indexing.
+
+.. data:: pi
+
+   ``float``:
+        IEEE 754 floating-point representation of the mathematical constant π.

doc/reference/tensor.creation_functions.rst

@@ -0,0 +1,32 @@
+.. _dpnp_tensor_creation_functions:
+
+Array creation functions
+========================
+
+The following functions in :py:mod:`dpnp.tensor` can be used
+to create new arrays:
+
+.. currentmodule:: dpnp.tensor
+
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    arange
+    asarray
+    empty
+    empty_like
+    eye
+    from_dlpack
+    full
+    full_like
+    linspace
+    meshgrid
+    ones
+    ones_like
+    tril
+    triu
+    zeros
+    zeros_like
+    from_numpy
+    copy

doc/reference/tensor.data_type_functions.rst

@@ -0,0 +1,22 @@
+.. _dpnp_tensor_data_type_functions:
+
+Data type functions
+===================
+
+The package :py:mod:`dpnp.tensor` contains the following data type functions conforming
+to `Python Array API specification <array_api_data_type_fns_>`_:
+
+.. _array_api_data_type_fns: https://data-apis.org/array-api/latest/API_specification/data_type_functions.html
+
+.. currentmodule:: dpnp.tensor
+
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    astype
+    can_cast
+    finfo
+    iinfo
+    isdtype
+    result_type