Skip to content

Commit

Permalink
SWDEV-427628 - Documentation restructure
Browse files Browse the repository at this point in the history
Upstream of documentation restructure and adds some of the absent math
and async function documentation.

Change-Id: Ia7a6fbe053afe85015b04e20a610115be3c664af
  • Loading branch information
MathiasMagnus committed Mar 7, 2024
1 parent edf2e47 commit ead76d3
Show file tree
Hide file tree
Showing 29 changed files with 2,829 additions and 5,905 deletions.
3 changes: 3 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,6 @@ build:
apt_packages:
- "doxygen"
- "graphviz" # For dot graphs in doxygen
jobs:
post_checkout:
- git clone --depth=1 --branch rocdoc-195 https://github.com/StreamHPC/llvm-project.git ../llvm-project
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# Contributor Guidelines
# Contributor guidelines

## Make Tips
`ROCM_PATH` is path where ROCM is installed. BY default `ROCM_PATH` is `/opt/rocm`.
If you want to contribute to the HIP project, review the following guidelines. If you want to contribute
to our documentation, refer to {doc}`Contribute to ROCm docs <rocm:contribute/index>`.

## Make tips

`ROCM_PATH` is path where ROCm is installed. BY default `ROCM_PATH` is `/opt/rocm`.
When building HIP, you will likely want to build and install to a local user-accessible directory (rather than `<ROCM_PATH>`).
This can be easily be done by setting the `-DCMAKE_INSTALL_PREFIX` variable when running cmake. Typical use case is to
set `CMAKE_INSTALL_PREFIX` to your HIP git root, and then ensure `HIP_PATH` points to this directory. For example
Expand All @@ -15,9 +19,8 @@ export HIP_PATH=

After making HIP, don't forget the "make install" step !

## Add a new HIP API


## Adding a new HIP API
- Add a translation to the hipify-clang tool ; many examples abound.
- For stat tracking purposes, place the API into an appropriate stat category ("dev", "mem", "stream", etc).
- Add a inlined NVIDIA implementation for the function in include/hip/nvidia_detail/hip_runtime_api.h.
Expand Down
3 changes: 3 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,6 @@

for sphinx_var in ROCmDocs.SPHINX_VARS:
globals()[sphinx_var] = getattr(docs_core, sphinx_var)

cpp_id_attributes = ["__global__", "__device__", "__host__", "__forceinline__", "static"]
cpp_paren_attributes = ["__declspec"]
200 changes: 0 additions & 200 deletions docs/developer_guide/build.md

This file was deleted.

Loading

0 comments on commit ead76d3

Please sign in to comment.