diff --git a/docs/index.rst b/docs/index.rst index 04cafd182a..f320567b49 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,6 @@ .. meta:: :description: rocDecode documentation and API reference library - :keywords: rocDecode, ROCm, API, documentation + :keywords: rocDecode, ROCm, API, documentation, video, decode, decoding, acceleration ******************************************************************** rocDecode documentation @@ -10,36 +10,42 @@ rocDecode provides APIs, utilities, and samples that you can use to easily acces features of your media engines (VCNs). It also allows interoperability with other compute engines on the GPU using Video Acceleration API (VA-API)/HIP. To learn more, see :doc:`what-is-rocDecode` -You can access rocDecode code on the `GitHub repository `_. +The code is open and hosted at ``_. -The documentation is structured as follows: .. grid:: 2 :gutter: 3 .. grid-item-card:: Install - * :doc:`Quick-start <./install/quick-start>` + * :doc:`Quick start <./install/quick-start>` * :doc:`rocDecode installation <./install/install>` - .. grid-item-card:: API reference - * :doc:`API library <../doxygen/html/files>` - * :doc:`Functions <../doxygen/html/globals>` - * :doc:`Data structures <../doxygen/html/annotated>` +The documentation is structured as follows: - .. grid-item-card:: How to - - * :doc:`Use rocDecode ` - - .. grid-item-card:: Conceptual - - * :doc:`Video decoding pipeline <./conceptual/video-decoding-pipeline>` +.. grid:: 2 + :gutter: 3 .. grid-item-card:: Tutorials * `GitHub samples `_ + .. grid-item-card:: How to + + * :doc:`Using rocDecode ` + + .. grid-item-card:: Conceptual + + * :doc:`Video decoding pipeline <./conceptual/video-decoding-pipeline>` + + .. grid-item-card:: Reference + + * :doc:`API library <../doxygen/html/files>` + * :doc:`Functions <../doxygen/html/globals>` + * :doc:`Data structures <../doxygen/html/annotated>` + + To contribute to the documentation, refer to `Contributing to ROCm `_. diff --git a/docs/install/install.rst b/docs/install/install.rst index 7086ffef7c..3c7969add1 100644 --- a/docs/install/install.rst +++ b/docs/install/install.rst @@ -52,7 +52,7 @@ Prerequisites `amdgpu-install `_ * Run: ``--usecase=rocm`` - * To install rocDecode with minimum requirements, follow the :doc:`quick-start instructions <./quick-start>` + * To install rocDecode with minimum requirements, follow the :doc:`quick start instructions <./quick-start>` * Video Acceleration API Version ``1.5.0`` or later - ``Libva`` is an implementation for VA-API @@ -86,8 +86,7 @@ Prerequisites .. note:: - * All package installs are shown with the ``apt`` package manager. Use the appropriate package - manager for your operating system. + * All package installs are shown with the ``apt`` package manager. Use the appropriate package manager for your operating system. * On ``Ubuntu 22.04`` - Additional package required: ``libstdc++-12-dev`` diff --git a/docs/install/quick-start.rst b/docs/install/quick-start.rst index 9dc4cb5ee1..4d33f2a76b 100644 --- a/docs/install/quick-start.rst +++ b/docs/install/quick-start.rst @@ -3,7 +3,7 @@ :keywords: install, rocDecode, AMD, ROCm ******************************************************************** -rocDecode quick-start installation +rocDecode quick start installation ******************************************************************** To install the rocDecode runtime with minimum requirements, follow these steps: diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index 61c2367889..3f3ab5f837 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -9,11 +9,26 @@ subtrees: - caption: Install entries: - file: install/quick-start.rst - title: Quick-start + title: Quick start - file: install/install.md title: Installation guide -- caption: API reference +- caption: Tutorials + entries: + - url: https://github.com/ROCm/rocDecode/tree/develop/samples + title: GitHub samples + +- caption: How to + entries: + - file: how-to/using-rocdecode.rst + title: Using rocDecode + +- caption: Conceptual + entries: + - file: conceptual/video-decoding-pipeline.rst + title: Video decoding pipeline + +- caption: Reference entries: - file: doxygen/html/files title: API library @@ -22,21 +37,6 @@ subtrees: - file: doxygen/html/annotated title: Data structures -- caption: How to - entries: - - file: how-to/using-rocdecode.rst - title: Use rocDecode - -- caption: Conceptual - entries: - - file: conceptual/video-decoding-pipeline.rst - title: Video decoding pipeline - -- caption: Tutorials - entries: - - url: https://github.com/ROCm/rocDecode/tree/develop/samples - title: GitHub samples - - caption: About entries: - file: license.md diff --git a/docs/tutorials/README.md b/docs/tutorials/README.md new file mode 100644 index 0000000000..8da51d9f91 --- /dev/null +++ b/docs/tutorials/README.md @@ -0,0 +1 @@ +Placeholder to ensure docs/tutorials folder is created. Can remove once tutorial content is provided.