Merge branch 'master' of https://github.com/IntelPython/dpctl into use_glog

Author: vlad-perevezentsev

.github/workflows/generate-docs.yml

@@ -75,7 +75,7 @@ jobs:
           cmake .. -DDPCTL_USE_MULTIVERSION_TEMPLATE=ON \
                    -DDPCTL_ENABLE_DOXYREST=ON \
                    -DDoxyrest_DIR=`pwd`/doxyrest-2.1.2-linux-amd64
-          make Sphinx
+          make Sphinx || exit 1
           cd ..
           mv generated_docs/docs ~/docs
           git clean -dfx
@@ -90,7 +90,7 @@ jobs:
           echo `pwd`
           cd master
           git rm -rf *
-          mv ~/docs/* .
+          mv ~/docs/* . || exit 1
           git add .
           git config --global user.name 'github-actions[doc-deploy-bot]'
           git config --global user.email 'github-actions[doc-deploy-bot]@users.noreply.github.com'

CHANGELOG.md

@@ -13,10 +13,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - dpctl-capi is now renamed to `libsyclinterface` (#666).
 
-## [0.11.3] - 11/30/2021
+## [0.11.4] - 12/03/2021
 
 ### Fixed
+- Fix tests for nested context factories expecting for integration environment by @PokhodenkoSA in https://github.com/IntelPython/dpctl/pull/705
+
+## [0.11.3] - 11/30/2021
 
+### Fixed
 - Set the last byte in allocated char array to zero [cherry picked from #650] (#699)
 
 ## [0.11.2] - 11/29/2021

docs/.gitignore

@@ -1,6 +1,7 @@
 docs
 generated_docs
 docfiles/libsyclinterface
+docfiles/dpctl
 api
 build
 conf.py

docs/CMakeLists.txt

@@ -29,7 +29,7 @@ function(_setup_doxygen)
     if(DPCTL_ENABLE_DOXYGEN_HTML)
         set(GENERATE_HTML "YES")
     endif()
-    set(DOXYGEN_INPUT_DIR ../libsyclinterface/include)
+    set(DOXYGEN_INPUT_DIR ${CMAKE_CURRENT_SOURCE_DIR}/../libsyclinterface/include)
     set(DOXYGEN_OUTPUT_DIR ${DOC_OUTPUT_DIR}/doxygen)
     set(DOXYGEN_INDEX_FILE ${DOXYGEN_OUTPUT_DIR}/xml/index.xml)
     set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
@@ -62,30 +62,33 @@ endfunction()
 
 function(_setup_doxyrest)
     set(DOXYREST_OUTPUT_DIR_NAME docfiles/libsyclinterface)
+    # Set the DOXYREST_OUTPUT_DIR variable in both current and parent scope.
+    # The variable is used by _setup_sphinx when generating the conf.py file.
     set(DOXYREST_OUTPUT_DIR
         ${CMAKE_CURRENT_SOURCE_DIR}/${DOXYREST_OUTPUT_DIR_NAME}
         PARENT_SCOPE
     )
     set(DOXYREST_OUTPUT_DIR
        ${CMAKE_CURRENT_SOURCE_DIR}/${DOXYREST_OUTPUT_DIR_NAME}
-
     )
     set(DOXYREST_CONFIG_IN ${CMAKE_CURRENT_SOURCE_DIR}/doxyrest-config.lua.in)
     set(DOXYREST_CONFIG_OUT ${CMAKE_CURRENT_SOURCE_DIR}/doxyrest-config.lua)
     set(DOXYREST_OUTPUT ${DOXYREST_OUTPUT_DIR}/index.rst)
     set(DOXYGEN_OUTPUT_DIR ${DOC_OUTPUT_DIR}/doxygen)
+
     configure_file(${DOXYREST_CONFIG_IN} ${DOXYREST_CONFIG_OUT} @ONLY)
     configure_file(${INDEX_DOXYREST_IN} ${INDEX_OUT} @ONLY)
+
     add_custom_command(
         OUTPUT ${DOXYREST_OUTPUT}
         COMMAND
             ${DOXYREST_EXE} -c
             ${DOXYREST_CONFIG_OUT}
         WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
         DEPENDS
-        # Other docs files that can be edited manually
-        ${INDEX_OUT}
-        ${DOXYGEN_INDEX_FILE}
+            # Other docs files that can be edited manually
+            ${INDEX_OUT}
+            ${DOXYGEN_INDEX_FILE}
         MAIN_DEPENDENCY ${DOXYREST_CONFIG_OUT} ${DOXYREST_CONFIG_IN}
         COMMENT "Generating Doxyrest documentation"
     )
@@ -98,58 +101,58 @@ function(_setup_doxyrest)
 endfunction()
 
 function(_setup_sphinx)
+    set(GENERATE_RST_OUTPUT_DIR
+        ${CMAKE_CURRENT_SOURCE_DIR}/docfiles/dpctl
+    )
     set(SPHINX_SOURCE ${CMAKE_CURRENT_SOURCE_DIR})
     set(SPHINX_OUTPUT_DIR ${DOC_OUTPUT_DIR}/docs)
     set(SPHINX_INDEX_FILE ${SPHINX_OUTPUT_DIR}/index.html)
     set(SPHINX_CONF_IN ${SPHINX_SOURCE}/conf.in)
     set(SPHINX_CONF_OUT ${SPHINX_SOURCE}/conf.py)
-    # Only regenerate Sphinx when:
-    # - Doxygen has rerun
-    # - Our doc files have been updated
-    # - The Sphinx config has been updated
+    set(DPCTL_PYAPI_RST_FILE ${GENERATE_RST_OUTPUT_DIR}/dpctl_pyapi.rst)
+
     if(DPCTL_ENABLE_DOXYREST)
-        add_custom_command(
-            OUTPUT ${SPHINX_INDEX_FILE}
-            COMMAND
-                ${SPHINX_EXECUTABLE} -b html
-                ${SPHINX_SOURCE}
-                ${SPHINX_OUTPUT_DIR}
-            WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-            DEPENDS
-            # Other docs files that can be edited manually
-            ${CMAKE_CURRENT_SOURCE_DIR}/index.rst
-            ${DOXYGEN_INDEX_FILE}
-            MAIN_DEPENDENCY ${SPHINX_CONF_OUT} ${SPHINX_CONF_IN}
-            COMMENT "Generating Sphinx documentation"
-        )
-        # Target to generate Sphinx
-        add_custom_target(
-            Sphinx
-            ALL
-            DEPENDS Doxyrest ${SPHINX_INDEX_FILE}
-        )
+        set(DEPEND_ON_DOXYREST "Doxyrest")
     else()
         configure_file(${INDEX_NO_DOXYREST_IN} ${INDEX_OUT} @ONLY)
-        add_custom_command(
-            OUTPUT ${SPHINX_INDEX_FILE}
-            COMMAND
-                ${SPHINX_EXECUTABLE} -b html
-                ${SPHINX_SOURCE}
-                ${SPHINX_OUTPUT_DIR}
-            WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-            DEPENDS
-            # Other docs files that can be edited manually
-            ${CMAKE_CURRENT_SOURCE_DIR}/index.rst
-            MAIN_DEPENDENCY ${SPHINX_CONF_OUT} ${SPHINX_CONF_IN}
-            COMMENT "Generating Sphinx documentation"
-        )
-        # Target to generate Sphinx
-        add_custom_target(
-            Sphinx
-            ALL
-            DEPENDS ${SPHINX_INDEX_FILE}
-        )
     endif()
+
+    configure_file(
+        "${CMAKE_CURRENT_SOURCE_DIR}/generate_rst.py"
+        ${CMAKE_CURRENT_BINARY_DIR}
+    )
+    # A custom command to generate the Python API rst files
+    add_custom_command(
+        OUTPUT ${DPCTL_PYAPI_RST_FILE}
+        COMMAND ${CMAKE_COMMAND} -E make_directory ${GENERATE_RST_OUTPUT_DIR}
+        COMMAND
+            "${Python_EXECUTABLE}"
+            "${CMAKE_CURRENT_BINARY_DIR}/generate_rst.py"
+            --dir "${GENERATE_RST_OUTPUT_DIR}"
+            --module "dpctl"
+        COMMENT "Generating RST files for Python API of dpctl"
+    )
+    add_custom_command(
+        OUTPUT ${SPHINX_INDEX_FILE}
+        COMMAND
+            ${SPHINX_EXECUTABLE} -b html
+            ${SPHINX_SOURCE}
+            ${SPHINX_OUTPUT_DIR}
+        WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+        DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/index.rst
+        MAIN_DEPENDENCY ${SPHINX_CONF_OUT} ${SPHINX_CONF_IN}
+        COMMENT "Generating Sphinx documentation"
+    )
+    # Target to generate Sphinx. Note that the order of the dependencies is
+    # important, we want the rst files to generate prior to sphinx build.
+    add_custom_target(
+        Sphinx
+        ALL
+        DEPENDS
+            ${DEPEND_ON_DOXYREST}
+            ${DPCTL_PYAPI_RST_FILE}
+            ${SPHINX_INDEX_FILE}
+    )
     # Create a conf.py by replacing variables inside @@ with the current values
     configure_file(${SPHINX_CONF_IN} ${SPHINX_CONF_OUT} @ONLY)
 endfunction()
@@ -185,6 +188,8 @@ set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake" ${CMAKE_MODULE_PATH})
 find_package(Git)
 find_package(Sphinx REQUIRED)
 find_package(Doxygen REQUIRED)
+find_package(Python REQUIRED)
+
 if (DPCTL_ENABLE_DOXYREST)
     find_package(Lua REQUIRED)
     find_package(Doxyrest REQUIRED)
@@ -208,3 +213,11 @@ if(DPCTL_ENABLE_DOXYREST)
     _setup_doxyrest()
 endif()
 _setup_sphinx()
+
+set_property(
+    DIRECTORY
+    PROPERTY
+    ADDITIONAL_CLEAN_FILES
+        "${CMAKE_CURRENT_SOURCE_DIR}/docfiles/dpctl"
+        "${CMAKE_CURRENT_SOURCE_DIR}/docfiles/libsyclinterface"
+)

docs/Doxyfile.in

@@ -562,7 +562,7 @@ INTERNAL_DOCS          = NO
 # (including Cygwin) ands Mac users are advised to set this option to NO.
 # The default value is: system dependent.
 
-CASE_SENSE_NAMES       = YES
+CASE_SENSE_NAMES       = NO
 
 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
 # their full class and namespace scopes in the documentation. If set to YES, the

docs/conf.in

@@ -168,7 +168,7 @@ class AutoAutoSummary(Autosummary):
         if not include_public:
             include_public = []
         items = []
-        for name in sorted(obj.__dict__.keys()):
+        for name in sorted(dir(obj)):
             try:
                 documenter = get_documenter(app, safe_getattr(obj, name), obj)
             except AttributeError: