Prepare documentation (#57)
* Updated the readme file to point to the official documentation
* first commit of new documentation structure
* split up and reconfigured Using rocJpeg
* Updated the readme file to point to the official documentation
* first commit of new documentation structure
* split up and reconfigured Using rocJpeg
* fixed missing space
* All changes asked for in the PR except the Destroy Handles part.
* separated creating and destroying handles; added a destroying handles section; added links to hipmalloc() and hipfree()
* removed the installation and build sections so that it doesn't conflict/go out of sync with the official doc
* putting readme back the way it was, minus documentation section
* changed some wording around hipFree()
[ROCm/rocjpeg commit: 31610c7472]
This commit is contained in:
@@ -8,29 +8,37 @@ subtrees:
|
||||
|
||||
- caption: Install
|
||||
entries:
|
||||
- file: install/quick-start.rst
|
||||
title: Quick-start
|
||||
- file: install/install.md
|
||||
title: Installation guide
|
||||
|
||||
- caption: API reference
|
||||
entries:
|
||||
- file: doxygen/html/files
|
||||
title: API library
|
||||
- file: doxygen/html/globals
|
||||
title: Functions
|
||||
- file: doxygen/html/annotated
|
||||
title: Data structures
|
||||
- file: install/rocjpeg-prerequisites.rst
|
||||
title: rocJPEG installation prerequisites
|
||||
- file: install/rocjpeg-package-install.rst
|
||||
title: Installing rocJPEG with the package installer
|
||||
- file: install/rocjpeg-build-and-install.rst
|
||||
title: Building and installing rocJPEG from source code
|
||||
|
||||
- caption: How to
|
||||
entries:
|
||||
- file: how-to/using-rocjpeg.rst
|
||||
title: Use rocJPEG
|
||||
title: Using rocJPEG
|
||||
- file: how-to/rocjpeg-retrieve-image-info.rst
|
||||
title: Retrieving image information with rocJPEG
|
||||
- file: how-to/rocjpeg-decoding-a-jpeg-stream.rst
|
||||
title: Decoding a JPEG stream with rocJPEG
|
||||
|
||||
- caption: Tutorials
|
||||
- caption: Reference
|
||||
entries:
|
||||
- file: reference/rocjpeg-formats-and-architectures.rst
|
||||
title: rocJPEG subsampling and hardware capabilities
|
||||
- file: doxygen/html/files
|
||||
title: rocJPEG API library
|
||||
- file: doxygen/html/globals
|
||||
title: rocJPEG functions
|
||||
- file: doxygen/html/annotated
|
||||
title: rocJPEG data structures
|
||||
|
||||
- caption: Samples
|
||||
entries:
|
||||
- url: https://github.com/ROCm/rocJPEG/tree/develop/samples
|
||||
title: GitHub samples
|
||||
title: rocJPEG samples on GitHub
|
||||
|
||||
- caption: About
|
||||
entries:
|
||||
|
||||
Reference in New Issue
Block a user