Merge remote-tracking branch 'origin/master' into gold/2021

Author: oleksandr-pavlyk

.gitattributes

@@ -0,0 +1 @@
+dpctl/_version.py export-subst

.github/workflows/generate-coverage.yaml

@@ -32,9 +32,9 @@ jobs:
           sudo apt-get install intel-oneapi-compiler-dpcpp-cpp
           sudo apt-get install intel-oneapi-tbb
 
-      - name: Install CMake
+      - name: Install CMake and Ninja
         run: |
-          sudo apt-get install cmake
+          sudo apt-get install cmake ninja-build
 
       - name: Setup Python
         uses: actions/setup-python@v2
@@ -87,8 +87,18 @@ jobs:
           source /opt/intel/oneapi/setvars.sh
           export _SAVED_PATH=${PATH}
           export PATH=$(dirname $(dirname $(which icx)))/bin-llvm:${PATH}
-          python setup.py develop -- -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Debug -DCMAKE_C_COMPILER:PATH=icx -DCMAKE_CXX_COMPILER:PATH=icpx -DDPCTL_ENABLE_LO_PROGRAM_CREATION=ON -DDPCTL_GENERATE_COVERAGE=ON -DDPCTL_BUILD_CAPI_TESTS=ON -DDPCTL_COVERAGE_REPORT_OUTPUT_DIR=$(pwd)
-          make -C $(find _skbuild -name tests) lcov-genhtml
+          python setup.py develop --                                           \
+          -G "Ninja"                                                           \
+          -DCMAKE_BUILD_TYPE=Debug                                             \
+          -DCMAKE_C_COMPILER:PATH=icx                                          \
+          -DCMAKE_CXX_COMPILER:PATH=icpx                                       \
+          -DDPCTL_ENABLE_LO_PROGRAM_CREATION=ON                                \
+          -DDPCTL_GENERATE_COVERAGE=ON                                         \
+          -DDPCTL_BUILD_CAPI_TESTS=ON                                          \
+          -DDPCTL_COVERAGE_REPORT_OUTPUT_DIR=$(pwd)
+          pushd $(find _skbuild -name cmake-build)
+          cmake --build . --target lcov-genhtml || exit 1
+          popd
           export PATH=${_SAVED_PATH}
           unset _SAVED_PATH
           python -c "import dpctl; print(dpctl.__version__); dpctl.lsplatform()" || exit 1
@@ -98,7 +108,7 @@ jobs:
         shell: bash -l {0}
         run: |
           sudo gem install coveralls-lcov
-          pip install coveralls==3.2.0
+          pip install coveralls
 
       - name: Upload coverage data to coveralls.io
         shell: bash -l {0}

.github/workflows/generate-docs.yml

@@ -35,10 +35,10 @@ jobs:
         if: ${{ !github.event.pull_request || github.event.action != 'closed' }}
         run: |
           sudo apt-get install doxygen
-      - name: Install CMake
+      - name: Install CMake and Ninja
         if: ${{ !github.event.pull_request || github.event.action != 'closed' }}
         run: |
-          sudo apt-get install cmake
+          sudo apt-get install cmake ninja-build
       - name: Setup Python
         if: ${{ !github.event.pull_request || github.event.action != 'closed' }}
         uses: actions/setup-python@v2
@@ -55,31 +55,28 @@ jobs:
         with:
           fetch-depth: 0
           persist-credentials: false
-      - name: Build dpctl
-        if: ${{ !github.event.pull_request || github.event.action != 'closed' }}
-        shell: bash -l {0}
-        run: |
-          source /opt/intel/oneapi/setvars.sh
-          python setup.py develop -- -DCMAKE_C_COMPILER:PATH=icx -DCMAKE_CXX_COMPILER:PATH=icpx -DDPCTL_ENABLE_LO_PROGRAM_CREATION=ON -DDPCTL_DPCPP_HOME_DIR=${BUILD_PREFIX}
-          python -c "import dpctl; print(dpctl.__version__)" || exit 1
-      - name: Build docs
+      - name: Build dpctl+docs
         if: ${{ !github.event.pull_request || github.event.action != 'closed' }}
         shell: bash -l {0}
         run: |
           # Ensure that SYCL libraries are on LD_LIBRARY_PATH
           source /opt/intel/oneapi/setvars.sh
-          cd docs
-          mkdir -p build && cd build && rm -rf *
           wget https://github.com/vovkos/doxyrest/releases/download/doxyrest-2.1.2/doxyrest-2.1.2-linux-amd64.tar.xz
           tar xf doxyrest-2.1.2-linux-amd64.tar.xz
-          cmake .. -DDPCTL_USE_MULTIVERSION_TEMPLATE=ON \
-                   -DDPCTL_ENABLE_DOXYREST=ON \
-                   -DDoxyrest_DIR=`pwd`/doxyrest-2.1.2-linux-amd64
-          make Sphinx || exit 1
-          cd ..
-          mv generated_docs/docs ~/docs
+          python setup.py develop --                       \
+              -G "Ninja"                                   \
+              -DCMAKE_BUILD_TYPE=Debug                     \
+              -DCMAKE_C_COMPILER:PATH=icx                  \
+              -DCMAKE_CXX_COMPILER:PATH=icpx               \
+              -DDPCTL_ENABLE_LO_PROGRAM_CREATION=ON        \
+              -DDPCTL_GENERATE_DOCS=ON                     \
+              -DDPCTL_ENABLE_DOXYREST=ON                   \
+              -DDoxyrest_DIR=`pwd`/doxyrest-2.1.2-linux-amd64
+          python -c "import dpctl; print(dpctl.__version__)" || exit 1
+          cd "$(find _skbuild -name cmake-build)" || exit 1
+          cmake --build . --target Sphinx || exit 1
+          mv ../cmake-install/docs/docs ~/docs
           git clean -dfx
-          cd ..
       - name: Publish docs
         if: ${{ github.ref == 'refs/heads/master' }}
         shell: bash -l {0}

.github/workflows/os-llvm-sycl-build.yml

@@ -68,7 +68,7 @@ jobs:
       - name: Install system components
         shell: bash -l {0}
         run: |
-          sudo apt-get install cmake libtinfo5
+          sudo apt-get install cmake ninja-build libtinfo5
 
       - name: Setup Python
         uses: actions/setup-python@v2
@@ -97,6 +97,6 @@ jobs:
           export OCL_ICD_FILENAMES=libintelocl.so:libintelocl_emu.so
           clang++ --version
           sycl-ls
-          python setup.py develop -- -G "Unix Makefiles" -DCMAKE_C_COMPILER:PATH=clang -DCMAKE_CXX_COMPILER:PATH=clang++ -DDPCTL_ENABLE_LO_PROGRAM_CREATION=ON -DDPCTL_DPCPP_HOME_DIR=$(dirname $(dirname $(which clang))) -DDPCTL_DPCPP_FROM_ONEAPI=OFF
+          python setup.py develop -- -G Ninja -DCMAKE_C_COMPILER:PATH=clang -DCMAKE_CXX_COMPILER:PATH=clang++ -DDPCTL_ENABLE_LO_PROGRAM_CREATION=ON -DDPCTL_DPCPP_HOME_DIR=$(dirname $(dirname $(which clang))) -DDPCTL_DPCPP_FROM_ONEAPI=OFF
           python -c "import dpctl; dpctl.lsplatform()" || exit 1
           SYCL_ENABLE_HOST_DEVICE=1 python -m pytest -v dpctl/tests

CMakeLists.txt

@@ -15,7 +15,6 @@ add_subdirectory(libsyclinterface)
 file(GLOB _dpctl_capi_headers dpctl/apis/include/*.h*)
 install(FILES ${_dpctl_capi_headers}
     DESTINATION dpctl/include
-    COMPONENT DpctlCAPIHeaders
 )
 
 add_subdirectory(dpctl)

MANIFEST.in

@@ -1,4 +1,3 @@
-include versioneer.py
 recursive-include dpctl/include *.h
 include dpctl/include/dpctl4pybind11.hpp
 recursive-include dpctl *.pxd

conda-recipe/build.sh

@@ -6,7 +6,7 @@
 export LDFLAGS="$LDFLAGS -Wl,-rpath,$PREFIX/lib"
 
 ${PYTHON} setup.py clean --all
-export CMAKE_GENERATOR="Unix Makefiles"
+export CMAKE_GENERATOR="Ninja"
 SKBUILD_ARGS="-- -DCMAKE_C_COMPILER:PATH=icx -DCMAKE_CXX_COMPILER:PATH=icpx -DDPCTL_ENABLE_LO_PROGRAM_CREATION=ON -DDPCTL_DPCPP_HOME_DIR=${BUILD_PREFIX}"
 echo "${PYTHON} setup.py install ${SKBUILD_ARGS}"
 

conda-recipe/meta.yaml

@@ -20,8 +20,7 @@ requirements:
         - cython
         - cmake  >=3.21
         - python
-        - make                     # [unix]
-        - ninja                    # [win]
+        - ninja
         - scikit-build
         - numpy 1.19
         - wheel

docs/CMakeLists.txt

@@ -1,6 +1,3 @@
-cmake_minimum_required(VERSION 3.18 FATAL_ERROR)
-project("Data-parallel Control (dpctl)")
-
 # Option to generate rst for C API and add to Sphinx documentation
 option(DPCTL_ENABLE_DOXYREST
     "Enable generation of rst files for C API"
@@ -55,7 +52,6 @@ function(_setup_doxygen)
     # Target to generate only Doxygen documentation
     add_custom_target(
         Doxygen
-        ALL
         DEPENDS ${DOXYGEN_INDEX_FILE}
     )
 endfunction()
@@ -95,7 +91,6 @@ function(_setup_doxyrest)
     # Target to generate rst from Doxygen XML using Doxyrest
     add_custom_target(
         Doxyrest
-        ALL
         DEPENDS Doxygen ${DOXYREST_OUTPUT}
     )
 endfunction()
@@ -147,7 +142,6 @@ function(_setup_sphinx)
     # 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}
@@ -196,12 +190,7 @@ if (DPCTL_ENABLE_DOXYREST)
 endif()
 
 # Set the location where the generated docs are saved
-if(DPCTL_DOCGEN_PREFIX)
-    message(STATUS "Generating dpctl documents in " ${DPCTL_DOCGEN_PREFIX})
-    set(DOC_OUTPUT_DIR ${DPCTL_DOCGEN_PREFIX})
-else()
-    set(DOC_OUTPUT_DIR ${CMAKE_CURRENT_SOURCE_DIR}/generated_docs)
-endif()
+set(DOC_OUTPUT_DIR ${CMAKE_INSTALL_PREFIX}/docs)
 
 set(INDEX_NO_DOXYREST_IN ${CMAKE_CURRENT_SOURCE_DIR}/index_no_doxyrest.rst.in)
 set(INDEX_DOXYREST_IN ${CMAKE_CURRENT_SOURCE_DIR}/index_doxyrest.rst.in)

docs/README.md

@@ -32,58 +32,13 @@ sudo apt-get install liblua5.2-dev
 Generating the docs
 ===================
 
-The documentation should be generated using the provided `Cmake` build script.
-There are a few configurable options that can be used to select the type of
-documentation to generate.
+The helper script ``scripts/gen_docs.py`` is the preferred way to generate the
+documentation. The generated documentation html pages will be installed to the
+``CMAKE_INSTALL_PREFIX/docs`` directory.
 
-Build only Doxygen for C API
 ----------------------------
 ```bash
-cd dpctl/docs
-mkdir -p build
-cd build
-cmake ..
-make Doxygen
+python scripts/gen_docs.py --doxyrest-root=<PATH to Doxyrest installation>
 ```
-The above steps will generate the `Doxygen` files at
-`dpctl/docs/generated_docs/doxygen/html`. The documentation can also be
-generated at a custom location by providing the optional flag
-
-```bash
-cd dpctl/docs
-mkdir -p build
-cd build
-cmake .. -DDPCTL_DOCGEN_PREFIX=<WHERE_YOU_WANT_DOCS_TO_BE_GENERATED>
-make Doxygen
-```
-
-Build only Sphinx for Python API
---------------------------------
-```bash
-cd dpctl/docs
-mkdir -p build
-cd build
-cmake .. -DDPCTL_DOCGEN_PREFIX=<WHERE_YOU_WANT_DOCS_TO_BE_GENERATED>
-make Sphinx
-```
-
-The `make Sphinx` command will generate only the Python API docs for dpctl.
-
-Build consolidated docs
------------------------
-It is possible to generate a single site with both Python and C API docs. As
-mentioned before, `Doxyrest` and `Lua` are required to generate the consolidated
-site.
-
-```bash
-cd dpctl/docs
-mkdir -p build
-cd build
-cmake ..                                                     \
-  -DDPCTL_ENABLE_DOXYREST=ON                                 \
-  -DDoxyrest_DIR=<PATH_TO_DOXYREST_INSTALL_DIR>              \
-  -DDPCTL_DOCGEN_PREFIX=<WHERE_YOU_WANT_DOCS_TO_BE_GENERATED>
-make Sphinx
-```
-The `Doxyrest_DIR` flag is optional, but is needed when Doxyrest is installed in
-a non-system location.
+To skip generating the documentation for ``libsyclinterface``, the
+``--doxyrest-root`` option should be omitted.