Skip to content

Commit

Permalink
Add high-level information to index page
Browse files Browse the repository at this point in the history
  • Loading branch information
lawruble13 committed Jan 18, 2024
1 parent a4040b8 commit 2c2fc65
Showing 1 changed file with 30 additions and 2 deletions.
32 changes: 30 additions & 2 deletions docs/src/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,38 @@
sphinx-quickstart on Thu Sep 16 18:46:06 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. highlight:: cmake

ROCm CMake Build Tools
======================

rocm-cmake
==========
Summary
-------

ROCm CMake Build Tools (also stylized as "ROCmCMakeBuildTools" and previously
known as "rocm-cmake") is a collection of functions that unify and simplify the
CMake code of the ROCm components, as well as ensuring consistency across these
components.

Usage
-----

The ROCm CMake Build Tools are primarily used at build time of a library, and
as such are not runtime dependencies for any generated libraries, packages,
or executables.

The tools can be included into a CMake project by running::

find_package(ROCmCMakeBuildTools)
# or
find_package(ROCM) # deprecated, but included for backwards compatibility

Once the tools have been included in this manner, individual files may be
included by running ``include(<file_name>)``. The file names, and the
functions, variables, and macros accessible using each file are listed below.

Files & Contents
~~~~~~~~~~~~~~~~

- :any:`ROCMAnalyzers`
+ :any:`rocm_mark_as_analyzer`
Expand Down

0 comments on commit 2c2fc65

Please sign in to comment.