Skip to content

Fix the hyperlinks to dpctl Python Classes API docs. #667

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
merged 1 commit into from
Nov 10, 2021
Merged

Fix the hyperlinks to dpctl Python Classes API docs. #667

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 13 additions & 8 deletions docs/docfiles/dpctl_pyapi.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,19 @@ Sub-modules
Classes
-------

.. toctree::
:maxdepth: 1

`dpctl.SyclPlatform`<dpctl_pyapi/SyclPlatform> : A Python class representing `SYCL Platforms`<https://sycl.readthedocs.io/en/latest/iface/platform.html>
`dpctl.SyclDevice`<dpctl_pyapi/SyclDevice> : A Python class representing `SYCL Devices`<https://sycl.readthedocs.io/en/latest/iface/device.html>
`dpctl.SyclQueue`<dpctl_pyapi/SyclQueue> : A Python class representing `SYCL Queues`<https://sycl.readthedocs.io/en/latest/iface/queue.html>
`dpctl.SyclContext`<dpctl_pyapi/SyclContext> : A Python class representing `SYCL Contexts`<https://sycl.readthedocs.io/en/latest/iface/context.html>
`dpctl.SyclEvent`<dpctl_pyapi/SyclEvent> : A Python class representing `SYCL Events`<https://sycl.readthedocs.io/en/latest/iface/event.html>
.. list-table::
:widths: 25,50

* - :ref:`SyclPlatform_api`
- A Python class representing a `SYCL platform <https://sycl.readthedocs.io/en/latest/iface/platform.html>`_.
* - :ref:`SyclDevice_api`
- A Python class representing a `SYCL device <https://sycl.readthedocs.io/en/latest/iface/device.html>`_.
* - :ref:`SyclQueue_api`
- A Python class representing a `SYCL queue <https://sycl.readthedocs.io/en/latest/iface/queue.html>`_.
* - :ref:`SyclContext_api`
- A Python class representing a `SYCL context <https://sycl.readthedocs.io/en/latest/iface/context.html>`_.
* - :ref:`SyclEvent_api`
- A Python class representing a `SYCL event <https://sycl.readthedocs.io/en/latest/iface/event.html>`_.

Enumerations
------------
Expand Down