Skip to content

Commit 19578db

Browse files
samjwuyhuiYH
authored andcommitted
Apply and standardize Read the Docs documentation for HIPCC
Relates to #12 Relates to ROCm/rocm-docs-core#330 Change-Id: Ic6a67f6edb21898c2ac8cf1dce91e94c507af4ad
1 parent c062ef5 commit 19578db

File tree

4 files changed

+28
-8
lines changed

4 files changed

+28
-8
lines changed

.github/dependabot.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "pip" # See documentation for possible values
4+
directory: "/amd/hipcc/docs/sphinx" # Location of package manifests
5+
open-pull-requests-limit: 10
6+
schedule:
7+
interval: "daily"
8+
labels:
9+
- "documentation"
10+
reviewers:
11+
- "samjwu"

amd/hipcc/README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,39 +5,41 @@
55
<!-- toc -->
66

77
- [hipcc](#hipcc)
8-
* [Documentation](#documentation)
9-
* [Environment Variables](#envVar)
10-
* [Usage](#hipcc-usage)
11-
* [Building](#building)
12-
* [Testing](#testing)
8+
- [Documentation](#documentation)
9+
- [Environment Variables](#envVar)
10+
- [Usage](#usage)
11+
- [Building](#building)
12+
- [Testing](#testing)
1313

1414
<!-- tocstop -->
1515

1616
## <a name="hipcc"></a> hipcc
1717

18-
`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.
18+
`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.
1919

2020
`hipcc` will pass-through options to the target compiler. The tools calling hipcc must ensure the compiler options are appropriate for the target compiler.
2121

2222
## Documentation
2323

2424
Run the steps below to build documentation locally.
2525

26-
```
26+
```shell
2727
cd docs
2828

29-
pip3 install -r .sphinx/requirements.txt
29+
pip3 install -r sphinx/requirements.txt
3030

3131
python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
3232
```
3333

3434
### <a name="envVar"></a> Environment Variables
3535

3636
The environment variable HIP_PLATFORM may be used to specify amd/nvidia:
37+
3738
- HIP_PLATFORM='amd' or HIP_PLATFORM='nvidia'.
3839
- If HIP_PLATFORM is not set, then hipcc will attempt to auto-detect based on if nvcc is found.
3940

4041
Other environment variable controls:
42+
4143
- HIP_PATH : Path to HIP directory, default is one dir level above location of hipcc.
4244
- CUDA_PATH : Path to CUDA SDK (default /usr/local/cuda). Used on NVIDIA platforms only.
4345
- HSA_PATH : Path to HSA dir (defaults to ../../hsa relative to abs_path of hipcc). Used on AMD platforms only.

amd/hipcc/docs/license.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# License
2+
3+
```{include} ../LICENSE.txt
4+
```

amd/hipcc/docs/sphinx/_toc.yml.in

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,6 @@ subtrees:
88
- file: usage
99
- file: build
1010
- file: test
11+
- caption: About
12+
entries:
13+
- file: license

0 commit comments

Comments
 (0)