From 7dc094624a08267f1ee877fa2e8dd4204a9c1089 Mon Sep 17 00:00:00 2001 From: Jeffrey Novotny Date: Mon, 21 Oct 2024 14:37:13 -0400 Subject: [PATCH 1/2] Add metadata info and pointer to docs to the readme file (#193) (cherry picked from commit bd5800d5ac14f42870dbdf584653bc67e51d207a) --- README.md | 5 +++++ docs/license.md | 4 ++++ docs/tutorials/examples.rst | 3 +++ 3 files changed, 12 insertions(+) diff --git a/README.md b/README.md index e328ce47..c248e9d8 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,11 @@ This repository contains the source and testing for hipfort. This is a FORTRAN interface library for accessing GPU Kernels. +## Documentation + +> [!NOTE] +> The published hipfort documentation is available at [hipfort](https://rocm.docs.amd.com/projects/hipfort/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 hipfort/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). + ## Known issues * `hipSOLVER` interfaces will only work for AMD GPUs. diff --git a/docs/license.md b/docs/license.md index 1f8761f2..c200aea3 100644 --- a/docs/license.md +++ b/docs/license.md @@ -1,3 +1,7 @@ +.. meta:: + :description: hipFORT license information + :keywords: hipfort, ROCm, API, documentation, license + # License ```{include} ../LICENSE diff --git a/docs/tutorials/examples.rst b/docs/tutorials/examples.rst index 2a99d531..692bc856 100644 --- a/docs/tutorials/examples.rst +++ b/docs/tutorials/examples.rst @@ -1,3 +1,6 @@ +.. meta:: + :description: hipFORT examples and API references + :keywords: hipfort, ROCm, API, documentation, examples, tutorials ************* Examples From 2c356590ceef2b351a7c4cc6f01ddafae586724a Mon Sep 17 00:00:00 2001 From: Jeffrey Novotny Date: Tue, 29 Oct 2024 14:30:36 -0400 Subject: [PATCH 2/2] Fix metadata info --- docs/license.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/license.md b/docs/license.md index c200aea3..d4e15de6 100644 --- a/docs/license.md +++ b/docs/license.md @@ -1,6 +1,9 @@ -.. meta:: - :description: hipFORT license information - :keywords: hipfort, ROCm, API, documentation, license +--- +myst: + html_meta: + "description": "hipFORT license information" + "keywords": "hipfort, ROCm, API, documentation, license" +--- # License