Skip to content

Fix warnings thrown during Sphinx generation.' #720

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
Dec 10, 2021
Merged

Fix warnings thrown during Sphinx generation.' #720

Show file tree
Hide file tree
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
1 change: 0 additions & 1 deletion docs/docfiles/urls.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. __urls:

.. _buffer protocol: https://docs.python.org/3/c-api/buffer.html
.. _Data API: https://data-apis.github.io/array-api/latest/
Expand Down
6 changes: 6 additions & 0 deletions docs/generate_rst.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -527,11 +527,17 @@ def _write_function_groups_summary(o, mod, groups):
_write_line(output, ".. currentmodule:: " + module)
_write_empty_line(output)
_write_line(output, ".. automodule:: " + module)
_write_empty_line(output)
_write_submodules_summary_table(output, mod)
_write_empty_line(output)
_write_classes_summary_table(output, mod)
_write_empty_line(output)
_write_function_groups_summary(output, mod, _group_functions(mod))
_write_empty_line(output)
_write_enums_summary_table(output, mod)
_write_empty_line(output)
_write_exceptions_summary_table(output, mod)
_write_empty_line(output)
_write_include_urls(output)

return output.getvalue()
Expand Down
4 changes: 2 additions & 2 deletions dpctl/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,8 +133,8 @@


def get_include():
"""
Return the directory that contains the dpctl *.h header files.
r"""
Return the directory that contains the dpctl \*.h header files.

Extension modules that need to be compiled against dpctl should use
this function to locate the appropriate include directory.
Expand Down
4 changes: 3 additions & 1 deletion dpctl/_sycl_event.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,13 +259,15 @@ cdef class SyclEvent(_SyclEvent):
**SyclEventRef**. The ownership of the pointer inside the capsule is
passed to the caller, and pointer is deleted when the capsule goes out
of scope.

Returns:
:class:`pycapsule`: A capsule object storing a copy of the
``cl::sycl::event`` pointer belonging to thus
``cl::sycl::event`` pointer belonging to a
:class:`dpctl.SyclEvent` instance.
Raises:
ValueError: If the ``DPCTLEvent_Copy`` fails to copy the
``cl::sycl::event`` pointer.

"""
cdef DPCTLSyclEventRef ERef = NULL
ERef = DPCTLEvent_Copy(self._event_ref)
Expand Down