From a4001df457b5d7a863a1baf9d8690e16af01418e Mon Sep 17 00:00:00 2001 From: Jeffrey Novotny Date: Thu, 10 Oct 2024 16:55:03 -0400 Subject: [PATCH] Add note to read me with metadata and NVIDIA changes Add note to read me with metadata and NVIDIA changes (cherry picked from commit 4f36bcfe77c2ea8ede16c63fbd861ae5b2158df0) --- README.md | 4 ++-- docs/api.rst | 2 +- docs/index.rst | 2 +- docs/license.md | 7 +++++++ docs/overview.rst | 2 +- 5 files changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 905e9ac..794ccad 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,8 @@ and marshals results back to your application. ## Documentation -Documentation for hipFFT is available at -[https://rocm.docs.amd.com/projects/hipFFT/en/latest/](https://rocm.docs.amd.com/projects/hipFFT/en/latest/). +> [!NOTE] +> The published hipFFT documentation is available at [hipFFT](https://rocm.docs.amd.com/projects/hipFFT/en/latest/index.html) in an organized, easy-to-read format, with search and a table of contents. The documentation source files reside in the hipFFT/docs folder of this repository. As with all ROCm projects, the documentation is open source. For more information, see [Contribute to ROCm documentation](https://rocm.docs.amd.com/en/latest/contribute/contributing.html). To build our documentation locally, run the following code: diff --git a/docs/api.rst b/docs/api.rst index a7877cb..98aaa8d 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -9,7 +9,7 @@ hipFFT API Usage ******************************************************************** This section describes usage of the hipFFT library API. The hipFFT -API follows the `cuFFT`_ API. +API follows the NVIDIA `cuFFT`_ API. .. _cuFFT: https://docs.nvidia.com/cuda/cufft/ diff --git a/docs/index.rst b/docs/index.rst index 11780ae..a7a6259 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,7 +8,7 @@ hipFFT documentation ******************************************************************** -Welcome to the hipFFT documentation home page. hipFFT is an FFT marshalling library. Currently, hipFFT supports either rocFFT_ or cuFFT_ as the backend, as explained in :ref:`hipfft-overview`. +Welcome to the hipFFT documentation home page. hipFFT is an FFT marshalling library. Currently, hipFFT supports either rocFFT_ or NVIDIA cuFFT_ as the backend, as explained in :ref:`hipfft-overview`. .. _rocFFT: https://rocm.docs.amd.com/projects/rocFFT/en/latest/index.html .. _cuFFT: https://developer.nvidia.com/cufft diff --git a/docs/license.md b/docs/license.md index b6e36d7..1cefce2 100644 --- a/docs/license.md +++ b/docs/license.md @@ -1,3 +1,10 @@ +--- +myst: + html_meta: + "description": "hipFFT licensing information" + "keywords": "hipFFT, FFT, ROCm, API, documentation, license" +--- + # License ```{include} ../LICENSE.md diff --git a/docs/overview.rst b/docs/overview.rst index 85007b0..5f92a00 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -9,7 +9,7 @@ hipFFT Overview ******************************************************************** hipFFT is a GPU FFT marshalling library that supports -either `rocFFT`_ or `cuFFT`_ as the backend. +either `rocFFT`_ or NVIDIA `cuFFT`_ as the backend. hipFFT exports an interface that does not require the client to change, regardless of the chosen backend. It sits between the