Docs - Updates (#213)

* Docs - Updates

* Quick-start - Readme

* Docs - updates

* Docs - Change root

* Docs - Fix root

* cleanup

[ROCm/rocdecode commit: 53f3d68c6f]

projects/rocdecode/README.md

@@ -1,6 +1,7 @@
 [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
-<p align="center"><img width="70%" src="https://github.com/ROCm/rocDecode/blob/master/docs/data/AMD_rocDecode_Logo.png?raw=true" /></p>
+
+<p align="center"><img width="70%" src="https://raw.githubusercontent.com/ROCm/rocDecode/master/docs/data/AMD_rocDecode_Logo.png" /></p>
 
 rocDecode is a high performance video decode SDK for AMD GPUs. rocDecode API lets developers access the video decoding features available on the GPU.
 

projects/rocdecode/docs/conf.py

@@ -27,6 +27,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 import re
+import shutil
 
 from rocm_docs import ROCmDocs
 
@@ -37,6 +38,8 @@ with open('../CMakeLists.txt', encoding='utf-8') as f:
     version_number = match[1]
 left_nav_title = f"rocDecode {version_number} Documentation"
 
+shutil.copy2('../README.md','./quickStart.md')
+
 # for PDF output on Read the Docs
 project = "rocDecode Documentation"
 author = "Advanced Micro Devices, Inc."

projects/rocdecode/docs/doxygen/Doxyfile

@@ -944,7 +944,7 @@ WARN_LOGFILE           =
 # Note: If this tag is empty the current directory is searched.
 
 INPUT                  = ../../README.md \
-                        ../../api/rocDecode.h \
+                        ../../api/rocdecode.h \
                         ../../api/rocparser.h \
                         ../../utils/rocvideodecode/roc_video_dec.h \
                         ../../utils/video_demuxer.h

projects/rocdecode/docs/rocDecodeUserGuide.md

@@ -58,7 +58,7 @@ Table 1: Hardware video decoder capabilities
 
 ## Chapter 3: Video decoding pipeline
 
-<p align="center"><img width="70%" src="data/VideoDecoderPipeline.PNG" /></p>
+<p align="center"><img width="70%" src="https://raw.githubusercontent.com/ROCm/rocDecode/master/docs/data/VideoDecoderPipeline.PNG" /></p>
 
 There are three main components in the rocDecode shown in the figure above: Demuxer, Video Parser APIs, and Video Decode APIs.
 The Demuxer is based on FFMPEG. The demuxer extracts a segment of video data and sends it to the Video Parser. The parser then extracts crucial information such as picture and slice parameters, which is then sent to the Decoder APIs. These APIs submit the information to the hardware for the decoding of a frame. This process repeats in a loop until all frames have been decoded.

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

@@ -2,6 +2,15 @@
 # These comments will also be removed.
 root: doxygen/html/index
 subtrees:
+- caption: Quick-start
+  entries:
+  - file: quickStart
+- caption: API reference
+  entries:
+  - file: doxygen/html/files
+- caption: Tutorials
+  entries:
+  - file: rocDecodeUserGuide
 - caption: About
   entries:
   - file: license