Skip to content

Commit d381774

Browse files
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: 565959f]
1 parent 808ce95 commit d381774

File tree

5 files changed

+17
-17
lines changed

5 files changed

+17
-17
lines changed

projects/rocjpeg/docs/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ The rocJPEG public repository is located at `https://github.com/ROCm/rocJPEG <ht
2323

2424
.. grid-item-card:: How to
2525

26-
* :doc:`Using rocJPEG <how-to/using-rocjpeg>`
27-
* :doc:`Retrieving image information with rocJPEG <how-to/rocjpeg-retrieve-image-info>`
28-
* :doc:`Decoding a JPEG stream with rocJPEG <how-to/rocjpeg-decoding-a-jpeg-stream>`
26+
* :doc:`Use rocJPEG <how-to/using-rocjpeg>`
27+
* :doc:`Retrieve image information with rocJPEG <how-to/rocjpeg-retrieve-image-info>`
28+
* :doc:`Decode a JPEG stream with rocJPEG <how-to/rocjpeg-decoding-a-jpeg-stream>`
2929

3030
.. grid-item-card:: Samples
3131

projects/rocjpeg/docs/install/rocjpeg-build-and-install.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ These instructions are for building rocJPEG from its source code. If you will no
1010

1111
.. note::
1212

13-
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.
13+
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.
1414

1515
Use `rocJPEG-setup.py <https://github.com/ROCm/rocJPEG/blob/develop/rocJPEG-setup.py>`_ available from the rocJPEG GitHub repo to install the prerequisites:
1616

projects/rocjpeg/docs/install/rocjpeg-package-install.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Installing rocJPEG with the package installer
88

99
.. note::
1010

11-
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.
11+
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.
1212

1313
There are three rocJPEG packages available:
1414

projects/rocjpeg/docs/install/rocjpeg-prerequisites.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
rocJPEG prerequisites
77
********************************************************************
88

9-
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>`_.
9+
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>`_.
1010

11-
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.
11+
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.
1212

1313
rocJPEG can be installed on the following Linux environments:
1414

projects/rocjpeg/docs/sphinx/_toc.yml.in

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,20 @@ subtrees:
99
- caption: Install
1010
entries:
1111
- file: install/rocjpeg-prerequisites.rst
12-
title: rocJPEG installation prerequisites
12+
title: Installation prerequisites
1313
- file: install/rocjpeg-package-install.rst
14-
title: Installing rocJPEG with the package installer
14+
title: Installing with the package installer
1515
- file: install/rocjpeg-build-and-install.rst
16-
title: Building and installing rocJPEG from source code
16+
title: Building and installing from source code
1717

1818
- caption: How to
1919
entries:
2020
- file: how-to/using-rocjpeg.rst
21-
title: Using rocJPEG
21+
title: Use rocJPEG
2222
- file: how-to/rocjpeg-retrieve-image-info.rst
23-
title: Retrieving image information with rocJPEG
23+
title: Retrieve image information
2424
- file: how-to/rocjpeg-decoding-a-jpeg-stream.rst
25-
title: Decoding a JPEG stream with rocJPEG
25+
title: Decode a JPEG stream
2626

2727
- caption: Samples
2828
entries:
@@ -33,13 +33,13 @@ subtrees:
3333
- caption: Reference
3434
entries:
3535
- file: reference/rocjpeg-formats-and-architectures.rst
36-
title: rocJPEG subsampling and hardware capabilities
36+
title: Subsampling and hardware capabilities
3737
- file: doxygen/html/files
38-
title: rocJPEG API library
38+
title: API library
3939
- file: doxygen/html/globals
40-
title: rocJPEG functions
40+
title: Functions
4141
- file: doxygen/html/annotated
42-
title: rocJPEG data structures
42+
title: Data structures
4343

4444
- caption: About
4545
entries:

0 commit comments

Comments
 (0)