Fix warnings thrown during Sphinx generation.' (#720)

Author: Diptorup Deb

docs/docfiles/urls.rst

@@ -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/

docs/generate_rst.py

@@ -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()

dpctl/__init__.py

@@ -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.

dpctl/_sycl_event.pyx

@@ -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)