Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cherry-pick to release/rocm-rel-6.3: Add metadata info and pointer to docs to the readme file (#193) #195

Open
wants to merge 2 commits into
base: release/rocm-rel-6.3
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
7 changes: 7 additions & 0 deletions docs/license.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
myst:
html_meta:
"description": "hipFORT license information"
"keywords": "hipfort, ROCm, API, documentation, license"
---

# License

```{include} ../LICENSE
Expand Down
3 changes: 3 additions & 0 deletions docs/tutorials/examples.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: hipFORT examples and API references
:keywords: hipfort, ROCm, API, documentation, examples, tutorials

*************
Examples
Expand Down