Docs - removed explicit reference to a rocm version & brought up to style guide (#170)

Co-authored-by: Kiriti Gowda <kiritigowda@gmail.com>

[ROCm/rocjpeg commit: 565959f731]
Этот коммит содержится в:
spolifroni-amd
2025-09-05 19:46:05 -04:00
коммит произвёл GitHub
родитель 808ce9591a
Коммит d381774f62
5 изменённых файлов: 17 добавлений и 17 удалений
+3 -3
Просмотреть файл
@@ -23,9 +23,9 @@ The rocJPEG public repository is located at `https://github.com/ROCm/rocJPEG <ht
.. grid-item-card:: How to
* :doc:`Using rocJPEG <how-to/using-rocjpeg>`
* :doc:`Retrieving image information with rocJPEG <how-to/rocjpeg-retrieve-image-info>`
* :doc:`Decoding a JPEG stream with rocJPEG <how-to/rocjpeg-decoding-a-jpeg-stream>`
* :doc:`Use rocJPEG <how-to/using-rocjpeg>`
* :doc:`Retrieve image information with rocJPEG <how-to/rocjpeg-retrieve-image-info>`
* :doc:`Decode a JPEG stream with rocJPEG <how-to/rocjpeg-decoding-a-jpeg-stream>`
.. grid-item-card:: Samples
+1 -1
Просмотреть файл
@@ -10,7 +10,7 @@ These instructions are for building rocJPEG from its source code. If you will no
.. note::
ROCm 6.3.0 or later must be installed before installing rocJPEG. See `Quick start installation guide <https://rocm.docs.amd.com/projects/install-on-linux/en/latest/install/quick-start.html>`_ for detailed ROCm installation instructions.
ROCm must be installed before installing rocJPEG. See `Quick start installation guide <https://rocm.docs.amd.com/projects/install-on-linux/en/latest/install/quick-start.html>`_ for detailed ROCm installation instructions.
Use `rocJPEG-setup.py <https://github.com/ROCm/rocJPEG/blob/develop/rocJPEG-setup.py>`_ available from the rocJPEG GitHub repo to install the prerequisites:
+1 -1
Просмотреть файл
@@ -8,7 +8,7 @@ Installing rocJPEG with the package installer
.. note::
ROCm 6.3.0 or later must be installed before installing rocJPEG. See `Quick start installation guide <https://rocm.docs.amd.com/projects/install-on-linux/en/latest/install/quick-start.html>`_ for detailed ROCm installation instructions.
ROCm must be installed before installing rocJPEG. See `Quick start installation guide <https://rocm.docs.amd.com/projects/install-on-linux/en/latest/install/quick-start.html>`_ for detailed ROCm installation instructions.
There are three rocJPEG packages available:
+2 -2
Просмотреть файл
@@ -6,9 +6,9 @@
rocJPEG prerequisites
********************************************************************
rocJPEG requires ROCm 6.3 or later running on `accelerators based on the CDNA architecture <https://rocm.docs.amd.com/projects/install-on-linux/en/latest/reference/system-requirements.html>`_.
rocJPEG requires ROCm running on `accelerators based on the CDNA architecture <https://rocm.docs.amd.com/projects/install-on-linux/en/latest/reference/system-requirements.html>`_.
ROCm 6.3.0 or later must be installed before installing rocJPEG. See `Quick start installation guide <https://rocm.docs.amd.com/projects/install-on-linux/en/latest/install/quick-start.html>`_ for detailed ROCm installation instructions.
ROCm must be installed before installing rocJPEG. See `Quick start installation guide <https://rocm.docs.amd.com/projects/install-on-linux/en/latest/install/quick-start.html>`_ for detailed ROCm installation instructions.
rocJPEG can be installed on the following Linux environments:
+10 -10
Просмотреть файл
@@ -9,20 +9,20 @@ subtrees:
- caption: Install
entries:
- file: install/rocjpeg-prerequisites.rst
title: rocJPEG installation prerequisites
title: Installation prerequisites
- file: install/rocjpeg-package-install.rst
title: Installing rocJPEG with the package installer
title: Installing with the package installer
- file: install/rocjpeg-build-and-install.rst
title: Building and installing rocJPEG from source code
title: Building and installing from source code
- caption: How to
entries:
- file: how-to/using-rocjpeg.rst
title: Using rocJPEG
title: Use rocJPEG
- file: how-to/rocjpeg-retrieve-image-info.rst
title: Retrieving image information with rocJPEG
title: Retrieve image information
- file: how-to/rocjpeg-decoding-a-jpeg-stream.rst
title: Decoding a JPEG stream with rocJPEG
title: Decode a JPEG stream
- caption: Samples
entries:
@@ -33,13 +33,13 @@ subtrees:
- caption: Reference
entries:
- file: reference/rocjpeg-formats-and-architectures.rst
title: rocJPEG subsampling and hardware capabilities
title: Subsampling and hardware capabilities
- file: doxygen/html/files
title: rocJPEG API library
title: API library
- file: doxygen/html/globals
title: rocJPEG functions
title: Functions
- file: doxygen/html/annotated
title: rocJPEG data structures
title: Data structures
- caption: About
entries: