diff --git a/.github/dependabot.yml b/.github/dependabot.yml
new file mode 100644
index 0000000000000..6ab2bca1a4cc8
--- /dev/null
+++ b/.github/dependabot.yml
@@ -0,0 +1,11 @@
+version: 2
+updates:
+ - package-ecosystem: "pip" # See documentation for possible values
+ directory: "/amd/hipcc/docs/sphinx" # Location of package manifests
+ open-pull-requests-limit: 10
+ schedule:
+ interval: "daily"
+ labels:
+ - "documentation"
+ reviewers:
+ - "samjwu"
diff --git a/amd/hipcc/README.md b/amd/hipcc/README.md
index 6212a9bc0d024..f2390899125fb 100644
--- a/amd/hipcc/README.md
+++ b/amd/hipcc/README.md
@@ -5,17 +5,17 @@
- [hipcc](#hipcc)
- * [Documentation](#documentation)
- * [Environment Variables](#envVar)
- * [Usage](#hipcc-usage)
- * [Building](#building)
- * [Testing](#testing)
+ - [Documentation](#documentation)
+ - [Environment Variables](#envVar)
+ - [Usage](#usage)
+ - [Building](#building)
+ - [Testing](#testing)
## hipcc
-`hipcc` is a compiler driver utility that will call clang or nvcc, depending on target, and pass the appropriate include and library options for the target compiler and HIP infrastructure. Historically, `hipcc` was provided as a script in the HIP repo ( https://github.com/ROCm-Developer-Tools/HIP/blob/main/bin/hipcc ). The `hipcc` provided in this project provides the same functionality, but is a binary rather than a script. At some point in the future, the hipcc script will be deprecated and ultimately removed from the HIP repo.
+`hipcc` is a compiler driver utility that will call clang or nvcc, depending on target, and pass the appropriate include and library options for the target compiler and HIP infrastructure. Historically, `hipcc` was provided as a script in the HIP repo [https://github.com/ROCm-Developer-Tools/HIP/blob/main/bin/hipcc](https://github.com/ROCm-Developer-Tools/HIP/blob/main/bin/hipcc). The `hipcc` provided in this project provides the same functionality, but is a binary rather than a script. At some point in the future, the hipcc script will be deprecated and ultimately removed from the HIP repo.
`hipcc` will pass-through options to the target compiler. The tools calling hipcc must ensure the compiler options are appropriate for the target compiler.
@@ -23,10 +23,10 @@
Run the steps below to build documentation locally.
-```
+```shell
cd docs
-pip3 install -r .sphinx/requirements.txt
+pip3 install -r sphinx/requirements.txt
python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
```
@@ -34,10 +34,12 @@ python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
### Environment Variables
The environment variable HIP_PLATFORM may be used to specify amd/nvidia:
+
- HIP_PLATFORM='amd' or HIP_PLATFORM='nvidia'.
- If HIP_PLATFORM is not set, then hipcc will attempt to auto-detect based on if nvcc is found.
Other environment variable controls:
+
- HIP_PATH : Path to HIP directory, default is one dir level above location of hipcc.
- CUDA_PATH : Path to CUDA SDK (default /usr/local/cuda). Used on NVIDIA platforms only.
- HSA_PATH : Path to HSA dir (defaults to ../../hsa relative to abs_path of hipcc). Used on AMD platforms only.
diff --git a/amd/hipcc/docs/license.md b/amd/hipcc/docs/license.md
new file mode 100644
index 0000000000000..bfc65acd0326f
--- /dev/null
+++ b/amd/hipcc/docs/license.md
@@ -0,0 +1,4 @@
+# License
+
+```{include} ../LICENSE.txt
+```
diff --git a/amd/hipcc/docs/sphinx/_toc.yml.in b/amd/hipcc/docs/sphinx/_toc.yml.in
index 0dbd7788147f5..2d55ecdef5cb4 100644
--- a/amd/hipcc/docs/sphinx/_toc.yml.in
+++ b/amd/hipcc/docs/sphinx/_toc.yml.in
@@ -8,3 +8,6 @@ subtrees:
- file: usage
- file: build
- file: test
+ - caption: About
+ entries:
+ - file: license