Skip to content

Fix documentation build warnings and errors #2333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
antonwolfy merged 6 commits into from
Jul 9, 2026
Merged

Fix documentation build warnings and errors #2333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0dc8750
Updated utils documentation to remove obsolete functions and to docum…
antonwolfy Jul 8, 2026
24d77d7
Drop documentation for SyclQueueToOrderManagerMap, since it's a priva…
antonwolfy Jul 8, 2026
58ac021
Add missing but required blunk lines after `code-block::` bash direct…
antonwolfy Jul 8, 2026
5a478c7
Match each underline to its title's source-line length
antonwolfy Jul 8, 2026
e360b1e
Use anonymous hyperlink references to get rid of duplication warning
antonwolfy Jul 8, 2026
2c68a79
Add `constants.rst` to hidden toctree to resolve `WARNING: document i…
antonwolfy Jul 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/doc_sources/api_reference/dpctl/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,4 +96,5 @@
.. toctree::
:hidden:

constants
filter_selector_string
11 changes: 4 additions & 7 deletions docs/doc_sources/api_reference/dpctl/utils.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,11 @@

.. currentmodule:: dpctl.utils

.. autofunction:: get_execution_queue

.. autofunction:: get_coerced_usm_type

.. autofunction:: validate_usm_type

.. autofunction:: onetrace_enabled

.. autofunction:: intel_device_info

.. autoexception:: ExecutionPlacementError
.. data:: SequentialOrderManager

Thread-local object mapping each :class:`dpctl.SyclQueue` to an order
manager, used to ensure sequential ordering of offloaded tasks.
2 changes: 1 addition & 1 deletion docs/doc_sources/api_reference/dpctl_capi.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ API for :c:struct:`PySyclKernelObject`


API for :c:struct:`PySyclKernelBundleObject`
---------------------------------------
--------------------------------------------

.. c:function:: DPCTLSyclKernelBundleRef SyclKernelBundle_GetKernelBundleRef(struct PySyclKernelBundleObject *prog)

Expand Down
2 changes: 2 additions & 0 deletions docs/doc_sources/beginners_guides/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,7 @@ one architecture can be specified at a time.
To determine the architecture code (``<arch>``) for your AMD GPU, run:

.. code-block:: bash

rocminfo | grep 'Name: *gfx.*'

This will print names like ``gfx90a``, ``gfx1030``, etc.
Expand All @@ -225,6 +226,7 @@ You can then use one of them as the argument to ``--target-hip``.
For example:

.. code-block:: bash

python scripts/build_locally.py --verbose --target-hip=gfx1030

Alternatively, you can use the ``DPCTL_TARGET_HIP`` CMake option:
Expand Down
10 changes: 5 additions & 5 deletions docs/doc_sources/user_guides/environment_variables.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The value of the variable is a bit-mask, with the following supported values:
.. _env_var_ze_flat_device_hierarchy:

Variable ``ZE_FLAT_DEVICE_HIERARCHY``
--------------------------
-------------------------------------
Allows users to define the device hierarchy model exposed by Level Zero driver implementation.
Keep in mind :py:mod:`dpctl.get_composite_devices` will only work while this is set to ``COMBINED``.

Expand All @@ -58,7 +58,7 @@ Keep in mind :py:mod:`dpctl.get_composite_devices` will only work while this is
* - ``FLAT``
- Level Zero devices with multiple tiles will be exposed as a set of root devices, each corresponding to an individual tile. Enabled by default.

Read more about device hierarchy in `Level Zero Specification <https://oneapi-src.github.io/level-zero-spec/level-zero/latest/core/PROG.html#device-hierarchy>`_ and `Intel GPU article <https://www.intel.com/content/www/us/en/developer/articles/technical/flattening-gpu-tile-hierarchy.html>`_.
Read more about device hierarchy in `Level Zero Specification <https://oneapi-src.github.io/level-zero-spec/level-zero/latest/core/PROG.html#device-hierarchy>`__ and `Intel GPU article <https://www.intel.com/content/www/us/en/developer/articles/technical/flattening-gpu-tile-hierarchy.html>`__.

Variable ``ZE_AFFINITY_MASK``
-------------------------------
Expand All @@ -76,10 +76,10 @@ Therefore, we could use the second tile in each of four dual-tile GPUs with ``ZE
| **If the exposed tiles belong to different physical devices:**
| - A composite device is available for each physical device, and the tiles are accessible as component devices of their respective composite device.

Additional examples to illustrate this are in the detailed documentation for ``ZE_AFFINITY_MASK``, read more about it in `Level Zero Specification <https://oneapi-src.github.io/level-zero-spec/level-zero/latest/core/PROG.html#affinity-mask>`_.
Additional examples to illustrate this are in the detailed documentation for ``ZE_AFFINITY_MASK``, read more about it in `Level Zero Specification <https://oneapi-src.github.io/level-zero-spec/level-zero/latest/core/PROG.html#affinity-mask>`__.

Variable ``ZE_ENABLE_PCI_ID_DEVICE_ORDER``
-------------------------------
------------------------------------------
Forces driver to report devices from lowest to highest PCI bus ID.

.. list-table::
Expand All @@ -93,7 +93,7 @@ Forces driver to report devices from lowest to highest PCI bus ID.
- Enabled.

Variable ``ZE_SHARED_FORCE_DEVICE_ALLOC``
-------------------------------
-----------------------------------------
Forces all shared allocations into device memory

.. list-table::
Expand Down
Loading