-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #765 from IntelPython/docs/generate_docsv2
Add a script to generate documentation using new Cmake infrastructure
- Loading branch information
Showing
6 changed files
with
224 additions
and
80 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,171 @@ | ||
| # Data Parallel Control (dpctl) | ||
| # | ||
| # Copyright 2020-2021 Intel Corporation | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| import os | ||
| import subprocess | ||
| import sys | ||
|
|
||
|
|
||
| def run( | ||
| use_oneapi=True, | ||
| c_compiler=None, | ||
| cxx_compiler=None, | ||
| level_zero=True, | ||
| compiler_root=None, | ||
| bin_llvm=None, | ||
| doxyrest_dir=None, | ||
| ): | ||
| IS_LIN = False | ||
|
|
||
| if "linux" in sys.platform: | ||
| IS_LIN = True | ||
| elif sys.platform in ["win32", "cygwin"]: | ||
| pass | ||
| else: | ||
| assert False, sys.platform + " not supported" | ||
|
|
||
| if not IS_LIN: | ||
| raise RuntimeError( | ||
| "This scripts only supports coverage collection on Linux" | ||
| ) | ||
| setup_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) | ||
| cmake_args = [ | ||
| sys.executable, | ||
| "setup.py", | ||
| "develop", | ||
| "--", | ||
| "-G", | ||
| "Unix Makefiles", | ||
| "-DCMAKE_BUILD_TYPE=Debug", | ||
| "-DCMAKE_C_COMPILER:PATH=" + c_compiler, | ||
| "-DCMAKE_CXX_COMPILER:PATH=" + cxx_compiler, | ||
| "-DDPCTL_ENABLE_LO_PROGRAM_CREATION=" + ("ON" if level_zero else "OFF"), | ||
| "-DDPCTL_DPCPP_FROM_ONEAPI:BOOL=" + ("ON" if use_oneapi else "OFF"), | ||
| "-DDPCTL_GENERATE_DOCS=ON", | ||
| ] | ||
|
|
||
| if doxyrest_dir: | ||
| cmake_args.append("-DDPCTL_ENABLE_DOXYREST=ON") | ||
| cmake_args.append("-DDoxyrest_DIR=" + doxyrest_dir) | ||
|
|
||
| if compiler_root: | ||
| cmake_args += [ | ||
| "-DDPCTL_DPCPP_HOME_DIR:PATH=" + compiler_root, | ||
| ] | ||
| env = None | ||
| if bin_llvm: | ||
| env = { | ||
| "PATH": ":".join((os.environ.get("PATH", ""), bin_llvm)), | ||
| } | ||
| env.update({k: v for k, v in os.environ.items() if k != "PATH"}) | ||
| # Install dpctl package | ||
| subprocess.check_call(cmake_args, shell=False, cwd=setup_dir, env=env) | ||
| # Get the path for the build directory | ||
| build_dir = ( | ||
| subprocess.check_output( | ||
| ["find", "_skbuild", "-name", "cmake-build"], | ||
| cwd=setup_dir, | ||
| ) | ||
| .decode("utf-8") | ||
| .strip("\n") | ||
| ) | ||
| # Generate docs | ||
| subprocess.check_call( | ||
| ["cmake", "--build", ".", "--target", "Sphinx"], cwd=build_dir | ||
| ) | ||
| generated_doc_dir = ( | ||
| subprocess.check_output( | ||
| ["find", "_skbuild", "-name", "index.html"], cwd=setup_dir | ||
| ) | ||
| .decode("utf-8") | ||
| .strip("\n") | ||
| ) | ||
| print("Generated documentation placed under ", generated_doc_dir) | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| import argparse | ||
|
|
||
| parser = argparse.ArgumentParser( | ||
| description="Driver to build dpctl and generate coverage" | ||
| ) | ||
| driver = parser.add_argument_group(title="Coverage driver arguments") | ||
| driver.add_argument("--c-compiler", help="Name of C compiler", default=None) | ||
| driver.add_argument( | ||
| "--cxx-compiler", help="Name of C++ compiler", default=None | ||
| ) | ||
| driver.add_argument( | ||
| "--not-oneapi", | ||
| help="Is one-API installation", | ||
| dest="oneapi", | ||
| action="store_false", | ||
| ) | ||
| driver.add_argument( | ||
| "--compiler-root", type=str, help="Path to compiler home directory" | ||
| ) | ||
| driver.add_argument( | ||
| "--no-level-zero", | ||
| help="Enable Level Zero support", | ||
| dest="level_zero", | ||
| action="store_false", | ||
| ) | ||
| driver.add_argument( | ||
| "--bin-llvm", help="Path to folder where llvm-cov can be found" | ||
| ) | ||
| driver.add_argument( | ||
| "--doxyrest-root", | ||
| help=( | ||
| "Path to Doxyrest installation to use to generate Sphinx docs" | ||
| + "for libsyclinterface" | ||
| ), | ||
| ) | ||
|
|
||
| args = parser.parse_args() | ||
|
|
||
| if args.oneapi: | ||
| args.c_compiler = "icx" | ||
| args.cxx_compiler = "icpx" | ||
| args.compiler_root = None | ||
| icx_path = subprocess.check_output(["which", "icx"]) | ||
| bin_dir = os.path.dirname(os.path.dirname(icx_path)) | ||
| args.bin_llvm = os.path.join(bin_dir.decode("utf-8"), "bin-llvm") | ||
| else: | ||
| args_to_validate = [ | ||
| "c_compiler", | ||
| "cxx_compiler", | ||
| "compiler_root", | ||
| "bin_llvm", | ||
| ] | ||
| for p in args_to_validate: | ||
| arg = getattr(args, p, None) | ||
| if not isinstance(arg, str): | ||
| opt_name = p.replace("_", "-") | ||
| raise RuntimeError( | ||
| f"Option {opt_name} must be provided is " | ||
| "using non-default DPC++ layout" | ||
| ) | ||
| if not os.path.exists(arg): | ||
| raise RuntimeError(f"Path {arg} must exist") | ||
|
|
||
| run( | ||
| use_oneapi=args.oneapi, | ||
| c_compiler=args.c_compiler, | ||
| cxx_compiler=args.cxx_compiler, | ||
| level_zero=args.level_zero, | ||
| compiler_root=args.compiler_root, | ||
| bin_llvm=args.bin_llvm, | ||
| doxyrest_dir=args.doxyrest_root, | ||
| ) |