Documentation - 6.1 Updates (Lisa edits) (#260)

* Update video-decoding-pipeline.md

changed image alignment to left from center

* Update Create-a-decoder-using-rocDecCreateDecoder().md

language edits

* Update Create-parser-object-using-rocDecCreateVideoParser().md

Language edits

* Update Create-parser-object-using-rocDecCreateVideoParser().md

* Update Create-parser-object-using-rocDecCreateVideoParser().md

* Update Create-parser-object-using-rocDecCreateVideoParser().md

* Update Create-parser-object-using-rocDecCreateVideoParser().md

* Update Create-parser-object-using-rocDecCreateVideoParser().md

expanded SEI

* Update Decode-the-frame-using-rocDecDecodeFrame().md

language edits

* Update Destroy-the-decoder.md

* Update Decode-the-frame-using-rocDecDecodeFrame().md

* Update Destroy-the-parser-using-rocDecDestroyVideoParser().md

* Update Parse-video-data-using-rocDecParseVideoData().md

language and spacing edits

* Update Prepare-the-decoded-frame-for-further-processing.md

language and spacing edits

* Update Query-decode-capabilities-using-rocDecGetDecoderCaps().md

Language and spacing edits.

* Update Query-the-decoding-status.md

language edits and spacing

* Update Reconfigure-the-decorder.md

language edits and spacing fixes

* Update Use-rocDecode-API.md

language and spacing edits

* Update Use-rocDecode-API.md

* Update Destroy-the-decoder.md

updated to RocDecoder

* Update Parse-video-data-using-rocDecParseVideoData().md

Added link for callback

* Update Reconfigure-the-decorder.md

Corrected to  RocDecoder

* Delete docs/tutorial directory

Tutorial not required for the user guide.

* Add files via upload

* Delete docs/data/VideoDecoderPipeline.PNG

* Update video-decoding-pipeline.md

* Update video-decoding-pipeline.md

* Update video-decoding-pipeline.md

* Update README.md

* resolve conflicts

* Update video-decoding-pipeline.md

* Update video-decoding-pipeline.md

* Update video-decoding-pipeline.md

* Update install.md

* Update install.md

Minor language edits.

* Update install.md

* Update install.md

* Update install.md

* Update install.md

* Update README.md

Updated link to 
https://github.com/ROCm/rocDecode/blob/develop/rocDecode-setup.py

* Update _toc.yml.in

* Update index.md

* Update index.md

* Update index.md

corrections to index.md

* Update index.md

* Update index.md

* Create index.md

* Update index.md

Updated for installation and how to. Reference has header files. Need confirmation.

* Update index.md

* Update index.md

Changed AMD's rocDecode SDK Library to rocDecode SDK

* Update what-is-rocDecode.md

* Update _toc.yml.in

* Update _toc.yml.in

* Update _toc.yml.in

* Update _toc.yml.in

* Update _toc.yml.in

* Update _toc.yml.in

* Update index.md

* Update index.md

* Update index.md

* Update index.md

* Docs - Update config

* Docs - yml updates

* Docs - Updates

* Update _toc.yml.in

* Update _toc.yml.in

* Update _toc.yml.in

* Update what-is-rocDecode.md

* Update _toc.yml.in

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

Added installation content

* Update _toc.yml.in

* Update install.md

changed heading to Installation

* Update index.md

* Update what-is-rocDecode.md

removed installation content

* Update what-is-rocDecode.md

Updated product name

* Update install.md

* Update _toc.yml.in

* Update Create-a-decoder-using-rocDecCreateDecoder.md

* Update Create-parser-object-using-rocDecCreateVideoParser.md

* Update Decode-the-frame-using-rocDecDecodeFrame.md

* Update Destroy-the-decoder.md

* Update Destroy-the-parser-using-rocDecDestroyVideoParser.md

* Update Parse-video-data-using-rocDecParseVideoData.md

* Update Prepare-the-decoded-frame-for-further-processing.md

* Update Query-decode-capabilities-using-rocDecGetDecoderCaps.md

* Update Query-the-decoding-status.md

* Update Reconfigure-the-decorder.md

* Update Use-rocDecode-API.md

* Update _toc.yml.in

* Update _toc.yml.in

* Update index.md

* Update index.md

* Index - Change to RST

* Fix - index

* Update conf.py

copyright

* Cleanup - Index

* Update _toc.yml.in

* Update _toc.yml.in

* Update what-is-rocDecode.md

Added concept

* Add files via upload

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

* Rename VideoDecoderPipeline (1).png to VideoDecoderPipelinetest.png

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

* Rename VideoDecoderPipeline.png to VideoDecoderPipelinetest.png

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

* Update index.md

Added a numbered list of actions.

* Update index.md

add links

* Update index.md

* Update index.md

* Update index.md

* Update index.md

* Update index.md

* Update index.md

* Update index.md

* Update index.md

* Update index.md

* Update index.md

* Update index.md

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.md

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.md

corrected the order of steps.

* Update index.rst

Corrected the order of tasks

* Update _toc.yml.in

Reorder the how to

* Update install.md

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

updated image path

* Update index.rst

Fixed Reconfigure the decoder <https://github.com/ROCm/rocDecode/blob/master/docs/how-to/Reconfigure-the-decorder.html>`_to
Reconfigure the decoder <https://github.com/ROCm/rocDecode/blob/master/docs/how-to/Reconfigure-the-decoder.html>`_

* Rename Reconfigure-the-decorder.md to Reconfigure-the-decoder.md

Corrected the page name to Reconfigure the decoder

* Update index.rst

Updated to relative links

* Update index.rst

Updated index.rst

* Update index.rst

* Update index.md

* Update index.md

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

updated ref to doc

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Add files via upload

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.md

* Update index.md

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

* Update install.md

* Update install.md

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

* Update what-is-rocDecode.md

* Update index.md

* Update index.md

* Update _toc.yml.in

* Update _toc.yml.in

* Update what-is-rocDecode.md

* Update install.md

* Update install.md

* Update what-is-rocDecode.md

* Update index.md

* restructure & edits

* udpate readme

* cleanup

* verbiage

* minor fixes

* update changelog

* update changelog

* update title

* add metadata

* more metadata

* convert to RST

* intersphinx test

* edits, install reorg, address comments

* verbiage

* update requirements

* remove extraneous note

* Update docs/sphinx/requirements.in

* clean up install info

* update readme

* update readme

* update requirements

* formatting

* revert requirements

* Docs - Update Requirements

* requirements

* Update requirements

* Fix typo in requirements

pip-compile error

---------

Co-authored-by: Roopa Malavally <56051583+Rmalavally@users.noreply.github.com>
Co-authored-by: Kiriti Gowda <kiritigowda@gmail.com>
Co-authored-by: Pavel Tcherniaev <Pavel.Tcherniaev@amd.com>
Co-authored-by: Sam Wu <sjwu@ualberta.ca>
Co-authored-by: kiritigowda <kiriti.nageshgowda@amd.com>
Co-authored-by: Sam Wu <sam.wu2@amd.com>
This commit is contained in:
Lisa
2024-02-27 14:42:03 -07:00
committed by GitHub
parent 5820a41421
commit 8a10f8be18
20 changed files with 866 additions and 379 deletions
+5 -14
View File
@@ -1,6 +1,6 @@
# MIT License
# Copyright (c) 2023 - 2024 Advanced Micro Devices, Inc.
# Copyright (c) 2023 - 2024 Advanced Micro Devices, Inc. All rights reserved.
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
@@ -17,7 +17,7 @@
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
# Configuration file for the Sphinx documentation builder.
@@ -27,7 +27,6 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html
import re
import shutil
from rocm_docs import ROCmDocs
@@ -36,20 +35,12 @@ with open('../CMakeLists.txt', encoding='utf-8') as f:
if not match:
raise ValueError("VERSION not found!")
version_number = match[1]
left_nav_title = f"rocDecode {version_number} Documentation"
shutil.copy2('../README.md','./quickStart.md')
shutil.copy2('../samples/README.md','./samples.md')
shutil.copy2('../samples/videoDecode/README.md','./videoDecode.md')
shutil.copy2('../samples/videoDecodeMem/README.md','./videoDecodeMem.md')
shutil.copy2('../samples/videoDecodeMultiFiles/README.md','./videoDecodeMultiFiles.md')
shutil.copy2('../samples/videoDecodePerf/README.md','./videoDecodePerf.md')
shutil.copy2('../samples/videoDecodeRGB/README.md','./videoDecodeRGB.md')
left_nav_title = f"rocDecode {version_number} documentation"
# for PDF output on Read the Docs
project = "rocDecode Documentation"
project = "rocDecode documentation"
author = "Advanced Micro Devices, Inc."
copyright = "Copyright (c) 2023 - 2024 Advanced Micro Devices, Inc. All rights reserved."
copyright = "Copyright (c) 2024 Advanced Micro Devices, Inc. All rights reserved."
version = version_number
release = version_number