feat(graphics): move to index file structure

StaticRocket · praneethbajjuri · commit 10ceaf6fd967 · 2025-04-17T14:27:07.000-05:00
This renames the Foundational_Components_Graphics landing page to index
and moves it under Foundational_Components/Graphics so it matches the
toctree structure.

Sphinx prefers the concept of indexes, landing pages that will break of
into additional sections and subsections. We've been using that
structure without actually calling them that or placing them in the
proper location.

Signed-off-by: Randolph Sapp &lt;rs@ti.com&gt;
diff --git a/configs/AM335X/AM335X_linux_toc.txt b/configs/AM335X/AM335X_linux_toc.txt
@@ -96,7 +96,7 @@ linux/Foundational_Components/Machine_Learning/tidl
 linux/Foundational_Components/Machine_Learning/tflite
 linux/Foundational_Components/Machine_Learning/tvm
 
-linux/Foundational_Components_Graphics
+linux/Foundational_Components/Graphics/index
 linux/Foundational_Components/Graphics/Common/Display
 linux/Foundational_Components/Graphics/Common/GTK+_Graphics_Framework
 linux/Foundational_Components/Graphics/Common/OpenGL_ES
diff --git a/configs/AM437X/AM437X_linux_toc.txt b/configs/AM437X/AM437X_linux_toc.txt
@@ -97,7 +97,7 @@ linux/Foundational_Components/Machine_Learning/tidl
 linux/Foundational_Components/Machine_Learning/tflite
 linux/Foundational_Components/Machine_Learning/tvm
 
-linux/Foundational_Components_Graphics
+linux/Foundational_Components/Graphics/index
 linux/Foundational_Components/Graphics/Common/Display
 linux/Foundational_Components/Graphics/Common/GTK+_Graphics_Framework
 linux/Foundational_Components/Graphics/Common/OpenGL_ES
diff --git a/configs/AM57X/AM57X_linux_toc.txt b/configs/AM57X/AM57X_linux_toc.txt
@@ -98,7 +98,7 @@ linux/Foundational_Components_CMEM
 linux/Foundational_Components_OPTEE
 linux/Foundational_Components_ATF
 
-linux/Foundational_Components_Graphics
+linux/Foundational_Components/Graphics/index
 linux/Foundational_Components/Graphics/Common/Display
 linux/Foundational_Components/Graphics/Common/GTK+_Graphics_Framework
 linux/Foundational_Components/Graphics/Common/OpenGL_ES
diff --git a/configs/AM62PX/AM62PX_linux_toc.txt b/configs/AM62PX/AM62PX_linux_toc.txt
@@ -121,7 +121,7 @@ linux/Foundational_Components/Virtualization/Docker
 linux/Foundational_Components_Hypervisor
 linux/Foundational_Components/Hypervisor/Jailhouse
 
-linux/Foundational_Components_Graphics
+linux/Foundational_Components/Graphics/index
 linux/Foundational_Components/Graphics/Common/Display
 linux/Foundational_Components/Graphics/Common/GTK+_Graphics_Framework
 linux/Foundational_Components/Graphics/Common/OpenGL_ES
diff --git a/configs/AM62X/AM62X_linux_toc.txt b/configs/AM62X/AM62X_linux_toc.txt
@@ -130,7 +130,7 @@ linux/Foundational_Components/Virtualization/Docker
 linux/Foundational_Components_Hypervisor
 linux/Foundational_Components/Hypervisor/Jailhouse
 
-linux/Foundational_Components_Graphics
+linux/Foundational_Components/Graphics/index
 linux/Foundational_Components/Graphics/Common/Display
 linux/Foundational_Components/Graphics/Common/GTK+_Graphics_Framework
 linux/Foundational_Components/Graphics/Common/OpenGL_ES
diff --git a/configs/AM65X/AM65X_linux_toc.txt b/configs/AM65X/AM65X_linux_toc.txt
@@ -94,7 +94,7 @@ linux/Foundational_Components/Virtualization/Docker
 linux/Foundational_Components_OPTEE
 linux/Foundational_Components_ATF
 
-linux/Foundational_Components_Graphics
+linux/Foundational_Components/Graphics/index
 linux/Foundational_Components/Graphics/Common/Display
 linux/Foundational_Components/Graphics/Common/GTK+_Graphics_Framework
 linux/Foundational_Components/Graphics/Common/OpenGL_ES
diff --git a/configs/AM67/AM67_linux_toc.txt b/configs/AM67/AM67_linux_toc.txt
@@ -87,7 +87,7 @@ linux/Foundational_Components_OPTEE
 linux/Foundational_Components_ATF
 linux/Foundational_Components_Multimedia_wave5
 
-linux/Foundational_Components_Graphics
+linux/Foundational_Components/Graphics/index
 linux/Foundational_Components/Graphics/Common/Display
 linux/Foundational_Components/Graphics/Common/GTK+_Graphics_Framework
 linux/Foundational_Components/Graphics/Common/OpenGL_ES
diff --git a/configs/AM67A/AM67A_linux_toc.txt b/configs/AM67A/AM67A_linux_toc.txt
@@ -88,7 +88,7 @@ linux/Foundational_Components_OPTEE
 linux/Foundational_Components_ATF
 linux/Foundational_Components_Multimedia_Other_Tools
 linux/Foundational_Components_Multimedia_wave5
-linux/Foundational_Components_Graphics
+linux/Foundational_Components/Graphics/index
 linux/Foundational_Components/Graphics/Common/Display
 linux/Foundational_Components/Graphics/Common/GTK+_Graphics_Framework
 linux/Foundational_Components/Graphics/Common/OpenGL_ES
diff --git a/configs/AM68/AM68_linux_toc.txt b/configs/AM68/AM68_linux_toc.txt
@@ -93,7 +93,7 @@ linux/Foundational_Components_OPTEE
 linux/Foundational_Components_ATF
 linux/Foundational_Components_Multimedia_wave5
 
-linux/Foundational_Components_Graphics
+linux/Foundational_Components/Graphics/index
 linux/Foundational_Components/Graphics/Common/Display
 linux/Foundational_Components/Graphics/Common/GTK+_Graphics_Framework
 linux/Foundational_Components/Graphics/Common/OpenGL_ES
diff --git a/configs/AM68A/AM68A_linux_toc.txt b/configs/AM68A/AM68A_linux_toc.txt
@@ -93,7 +93,7 @@ linux/Foundational_Components/Virtualization/Docker
 linux/Foundational_Components_OPTEE
 linux/Foundational_Components_ATF
 linux/Foundational_Components_Multimedia_wave5
-linux/Foundational_Components_Graphics
+linux/Foundational_Components/Graphics/index
 linux/Foundational_Components/Graphics/Common/Display
 linux/Foundational_Components/Graphics/Common/GTK+_Graphics_Framework
 linux/Foundational_Components/Graphics/Common/OpenGL_ES
diff --git a/configs/AM69/AM69_linux_toc.txt b/configs/AM69/AM69_linux_toc.txt
@@ -93,7 +93,7 @@ linux/Foundational_Components_OPTEE
 linux/Foundational_Components_ATF
 linux/Foundational_Components_Multimedia_wave5
 
-linux/Foundational_Components_Graphics
+linux/Foundational_Components/Graphics/index
 linux/Foundational_Components/Graphics/Common/Display
 linux/Foundational_Components/Graphics/Common/GTK+_Graphics_Framework
 linux/Foundational_Components/Graphics/Common/OpenGL_ES
diff --git a/configs/AM69A/AM69A_linux_toc.txt b/configs/AM69A/AM69A_linux_toc.txt
@@ -94,7 +94,7 @@ linux/Foundational_Components_OPTEE
 linux/Foundational_Components_ATF
 linux/Foundational_Components_Multimedia_Other_Tools
 linux/Foundational_Components_Multimedia_wave5
-linux/Foundational_Components_Graphics
+linux/Foundational_Components/Graphics/index
 linux/Foundational_Components/Graphics/Common/Display
 linux/Foundational_Components/Graphics/Common/GTK+_Graphics_Framework
 linux/Foundational_Components/Graphics/Common/OpenGL_ES
diff --git a/configs/GEN/GEN_linux_toc.txt b/configs/GEN/GEN_linux_toc.txt
@@ -120,7 +120,7 @@ linux/Foundational_Components/Machine_Learning/tvm
 linux/Foundational_Components_OPTEE
 linux/Foundational_Components_ATF
 
-linux/Foundational_Components_Graphics
+linux/Foundational_Components/Graphics/index
 linux/Foundational_Components/Graphics/Common/Display
 linux/Foundational_Components/Graphics/Common/GTK+_Graphics_Framework
 linux/Foundational_Components/Graphics/Common/OpenGL_ES
diff --git a/configs/J721E/J721E_linux_toc.txt b/configs/J721E/J721E_linux_toc.txt
@@ -97,7 +97,7 @@ linux/Foundational_Components_OPTEE
 linux/Foundational_Components_ATF
 linux/Foundational_Components_Multimedia_D5520_VXE384
 
-linux/Foundational_Components_Graphics
+linux/Foundational_Components/Graphics/index
 linux/Foundational_Components/Graphics/Common/Display
 linux/Foundational_Components/Graphics/Common/GTK+_Graphics_Framework
 linux/Foundational_Components/Graphics/Common/OpenGL_ES
diff --git a/configs/J721S2/J721S2_linux_toc.txt b/configs/J721S2/J721S2_linux_toc.txt
@@ -97,7 +97,7 @@ linux/Foundational_Components_OPTEE
 linux/Foundational_Components_ATF
 linux/Foundational_Components_Multimedia_wave5
 
-linux/Foundational_Components_Graphics
+linux/Foundational_Components/Graphics/index
 linux/Foundational_Components/Graphics/Common/Display
 linux/Foundational_Components/Graphics/Common/GTK+_Graphics_Framework
 linux/Foundational_Components/Graphics/Common/OpenGL_ES
diff --git a/configs/J722S/J722S_linux_toc.txt b/configs/J722S/J722S_linux_toc.txt
@@ -91,7 +91,7 @@ linux/Foundational_Components_OPTEE
 linux/Foundational_Components_ATF
 linux/Foundational_Components_Multimedia_wave5
 
-linux/Foundational_Components_Graphics
+linux/Foundational_Components/Graphics/index
 linux/Foundational_Components/Graphics/Common/Display
 linux/Foundational_Components/Graphics/Common/GTK+_Graphics_Framework
 linux/Foundational_Components/Graphics/Common/OpenGL_ES
diff --git a/configs/J742S2/J742S2_linux_toc.txt b/configs/J742S2/J742S2_linux_toc.txt
@@ -95,7 +95,7 @@ linux/Foundational_Components_OPTEE
 linux/Foundational_Components_ATF
 linux/Foundational_Components_Multimedia_wave5
 
-linux/Foundational_Components_Graphics
+linux/Foundational_Components/Graphics/index
 linux/Foundational_Components/Graphics/Common/Display
 linux/Foundational_Components/Graphics/Common/GTK+_Graphics_Framework
 linux/Foundational_Components/Graphics/Common/OpenGL_ES
diff --git a/configs/J784S4/J784S4_linux_toc.txt b/configs/J784S4/J784S4_linux_toc.txt
@@ -96,7 +96,7 @@ linux/Foundational_Components_OPTEE
 linux/Foundational_Components_ATF
 linux/Foundational_Components_Multimedia_wave5
 
-linux/Foundational_Components_Graphics
+linux/Foundational_Components/Graphics/index
 linux/Foundational_Components/Graphics/Common/Display
 linux/Foundational_Components/Graphics/Common/GTK+_Graphics_Framework
 linux/Foundational_Components/Graphics/Common/OpenGL_ES
diff --git a/configs/TDA4VM/TDA4VM_linux_toc.txt b/configs/TDA4VM/TDA4VM_linux_toc.txt
@@ -91,7 +91,7 @@ linux/Foundational_Components/Tools/Flash_Tools
 linux/Foundational_Components/Tools/Pin_Mux_Tools
 linux/Foundational_Components/Tools/Code_Composer_Studio
 linux/Foundational_Components_IPC_J721E
-linux/Foundational_Components_Graphics
+linux/Foundational_Components/Graphics/index
 linux/Foundational_Components/Graphics/Graphics_and_Display
 linux/Foundational_Components/Graphics/Rogue_Debug_Info
 linux/Foundational_Components/Graphics/Rogue_Power_Management_Info
diff --git a/source/linux/Examples_and_Demos_Sub-system_Demos.rst b/source/linux/Examples_and_Demos_Sub-system_Demos.rst
@@ -16,7 +16,7 @@ Refer to various GStreamer pipelines documented at `Multimedia <Foundational_Com
 
 Graphics and Display
 ====================
-Refer to various SGX 3D demos and other Graphics applications at `Graphics & Display <Foundational_Components_Graphics.html>`__ chapter.
+Refer to various SGX 3D demos and other Graphics applications at :doc:`Foundational_Components/Graphics/index` chapter.
 
 DSP offload with OpenCL
 =======================
diff --git a/source/linux/Foundational_Components.rst b/source/linux/Foundational_Components.rst
@@ -28,7 +28,7 @@ Foundational Components
    Foundational_Components_IPC64x
    Foundational_Components_IPCLLD
    Foundational_Components_CMEM
-   Foundational_Components_Graphics
+   Foundational_Components/Graphics/index
    Foundational_Components_Multimedia_IVAHD
    Foundational_Components_Multimedia_D5520_VXE384
    Foundational_Components_Multimedia_wave5
diff --git a/source/linux/Foundational_Components/Graphics/index.rst b/source/linux/Foundational_Components/Graphics/index.rst
@@ -0,0 +1,43 @@
+..
+    http://processors.wiki.ti.com/index.php/Processor_Linux_SDK_Graphics_and_Display
+    This is the top level section of the Graphics and Display chapter, all the
+    subsections are specified as a seperate rst file with toplevel headers in
+    them being of subsection level 2 header type.
+
+.. _foundational-components-graphics-and-display:
+
+####################
+Graphics and Display
+####################
+
+The TI SoC family of devices supported by this SDK have dedicated hardware
+blocks for accelerating 3D graphics and display composition. This page provides
+the details on the features supported by these hardware blocks.
+
+.. toctree::
+   :maxdepth: 5
+
+   SGX/Overview.rst
+   SGX/SGX_Debug_Info.rst
+   SGX/AM3_Beagle_Bone_Black_Configuration.rst
+   SGX/Migration_From_Prior_Releases.rst
+   SGX/OMAP_DRM.rst
+   SGX/Build_Guide.rst
+
+   Rogue/Overview.rst
+   Rogue/Rogue_Debug_Info.rst
+   Rogue/Rogue_Power_Management_Info.rst
+   Rogue/Build_Guide.rst
+
+   Common/Display.rst
+
+   Common/OpenGL_ES.rst
+   Common/Vulkan.rst
+   Common/OpenCL.rst
+
+   Common/QT_Graphics_Framework.rst
+   Common/GTK+_Graphics_Framework.rst
+
+   Common/Weston.rst
+   Common/PVR_Tools.rst
+
diff --git a/source/linux/Foundational_Components_Graphics.rst b/source/linux/Foundational_Components_Graphics.rst
diff --git a/source/linux/Foundational_Components_Multimedia_D5520_VXE384.rst b/source/linux/Foundational_Components_Multimedia_D5520_VXE384.rst
@@ -437,7 +437,7 @@ show how to playback to kmssink and waylandsink without playbin.
                 demux.audio_0 ! queue ! decodebin ! alsasink
 
 The following pipelines show playback to waylandsink. Please refer
-`Wayland/Weston <Foundational_Components_Graphics.html#wayland-weston>`__
+:doc:`Foundational_Components/Graphics/index`
 to start Weston before running the pipelines.
 
 .. code-block:: text
diff --git a/source/linux/How_to_Guides/Host/Additional_How_to_Guide_Links.rst b/source/linux/How_to_Guides/Host/Additional_How_to_Guide_Links.rst
@@ -1,6 +1,6 @@
 How to Develop with 3D Graphics
 ===============================
-Please refer to `Graphics & Display <../../Foundational_Components_Graphics.html>`__ chapter for details.
+Please refer to :doc:`../../Foundational_Components/Graphics/index` chapter for details.
 
 How to Develop accelerated Multimedia using GStreamer on AM57xx
 ===============================================================
