Skip to content

Commit 8d1203b

Browse files
StaticRocketStaticRocket
committed
feat: use sphinx_design for tab support
The sphinx_design extension has better integration with existing themes. It also unpacks its directives as a valid latex block for PDF generation. Signed-off-by: Randolph Sapp <rs@ti.com>
1 parent be96730 commit 8d1203b

8 files changed

Lines changed: 36 additions & 36 deletions

File tree

‎.rstcheck.cfg‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[rstcheck]
2-
ignore_directives = ifconfig,tabs,tab,group-tab,code-tab,graphviz
2+
ignore_directives = ifconfig,graphviz,grid,grid-item,grid-item-card,card,dropdown,tab-set,tab-set-code,tab-item,button-link,button-ref,article-info
33
# ignore the following languages because they require external compilers and
44
# snippets in this repo depend on external code
55
ignore_languages = c,cpp,c++

‎conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
'sphinx.ext.ifconfig',
4242
'sphinx.ext.graphviz',
4343
'sphinx_rtd_theme',
44-
'sphinx_tabs.tabs',
44+
'sphinx_design',
4545
'sphinx_copybutton'
4646
]
4747

‎docker/requirements.in‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ rstcheck==6.2.5
44
rstcheck-core @ git+https://github.com/StaticRocket/rstcheck-core.git@d935498cfc319d62fe2dde3012d81657510f0a90
55
Sphinx>=8.2.3
66
sphinx-copybutton>=0.5.2
7+
sphinx_design>=0.7.0
78
sphinx-rtd-theme>=3.0.2
8-
sphinx-tabs>=3.4.7

‎docker/requirements.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ shellingham==1.5.4
2525
snowballstemmer==3.1.1
2626
Sphinx==9.1.0
2727
sphinx-copybutton==0.5.2
28-
sphinx-tabs==3.5.0
28+
sphinx_design==0.7.0
2929
sphinx_rtd_theme==3.1.0
3030
sphinxcontrib-applehelp==2.0.0
3131
sphinxcontrib-devhelp==2.0.0

‎source/linux/Foundational_Components/Graphics/Rogue/_8XE_Extension_List.rst‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
.. tabs::
1+
.. tab-set::
22

3-
.. tab:: EGL client extensions
3+
.. tab-item:: EGL client extensions
44

55
.. list-table:: EGL client extensions
66

@@ -15,7 +15,7 @@
1515

1616
All extensions without links are custom IMG extensions.
1717

18-
.. tab:: EGL extensions
18+
.. tab-item:: EGL extensions
1919

2020
.. list-table:: EGL extensions
2121

@@ -43,13 +43,13 @@
4343
* - `EGL_MESA_drm_image <https://registry.khronos.org/EGL/extensions/MESA/EGL_MESA_drm_image.txt>`__
4444
* - `EGL_MESA_image_dma_buf_export <https://registry.khronos.org/EGL/extensions/MESA/EGL_MESA_image_dma_buf_export.txt>`__
4545
* - `EGL_WL_bind_wayland_display <https://registry.khronos.org/EGL/extensions/WL/EGL_WL_bind_wayland_display.txt>`__
46-
* - EGL_IMG_cl_image
47-
46+
* - EGL_IMG_cl_image
47+
4848
.. note::
4949

5050
All extensions without links are custom IMG extensions.
5151

52-
.. tab:: GL extensions
52+
.. tab-item:: GL extensions
5353

5454
.. list-table:: GL extensions
5555

@@ -68,7 +68,7 @@
6868
* - `GL_EXT_float_blend <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_float_blend.txt>`__
6969
* - `GL_EXT_geometry_point_size <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_geometry_shader.txt>`__
7070
* - `GL_EXT_geometry_shader <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_geometry_shader.txt>`__
71-
* - `GL_EXT_gpu_shader5 <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_gpu_shader5.txt>`__
71+
* - `GL_EXT_gpu_shader5 <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_gpu_shader5.txt>`__
7272
* - `GL_EXT_memory_object <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_external_objects.txt>`__
7373
* - `GL_EXT_multisampled_render_to_texture <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_multisampled_render_to_texture.txt>`__
7474
* - `GL_EXT_multisampled_render_to_texture2 <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_multisampled_render_to_texture2.txt>`__
@@ -157,7 +157,7 @@
157157

158158
All extensions without links are custom IMG extensions.
159159

160-
.. tab:: Vulkan instance extensions
160+
.. tab-item:: Vulkan instance extensions
161161

162162
.. list-table:: Vulkan instance extensions
163163

@@ -184,7 +184,7 @@
184184
* - `VK_EXT_debug_report <https://docs.vulkan.org/refpages/latest/refpages/source/VK_EXT_debug_report.html>`__
185185
- v10
186186
* - `VK_EXT_debug_utils <https://docs.vulkan.org/refpages/latest/refpages/source/VK_EXT_debug_utils.html>`__
187-
- v2
187+
- v2
188188

189189
.. note::
190190

‎source/linux/Foundational_Components/Graphics/Rogue/_AXE_Extension_List.rst‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
.. tabs::
1+
.. tab-set::
22

3-
.. tab:: EGL client extensions
3+
.. tab-item:: EGL client extensions
44

55
.. list-table:: EGL client extensions
66

@@ -22,7 +22,7 @@
2222

2323
All extensions without links are custom IMG extensions.
2424

25-
.. tab:: EGL extensions
25+
.. tab-item:: EGL extensions
2626

2727
.. list-table:: EGL extensions
2828

@@ -57,13 +57,13 @@
5757
* - `EGL_MESA_image_dma_buf_export <https://registry.khronos.org/EGL/extensions/MESA/EGL_MESA_image_dma_buf_export.txt>`__
5858
* - `EGL_WL_bind_wayland_display <https://registry.khronos.org/EGL/extensions/WL/EGL_WL_bind_wayland_display.txt>`__
5959
* - `EGL_WL_create_wayland_buffer_from_image <https://registry.khronos.org/EGL/extensions/WL/EGL_WL_create_wayland_buffer_from_image.txt>`__
60-
* - EGL_IMG_cl_image
60+
* - EGL_IMG_cl_image
6161

6262
.. note::
6363

6464
All extensions without links are custom IMG extensions.
6565

66-
.. tab:: GL extensions
66+
.. tab-item:: GL extensions
6767

6868
.. list-table:: GL extensions
6969

@@ -82,7 +82,7 @@
8282
* - `GL_EXT_draw_elements_base_vertex <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_draw_elements_base_vertex.txt>`__
8383
* - `GL_EXT_EGL_image_array <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_EGL_image_array.txt>`__
8484
* - `GL_EXT_float_blend <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_float_blend.txt>`__
85-
* - `GL_EXT_gpu_shader5 <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_gpu_shader5.txt>`__
85+
* - `GL_EXT_gpu_shader5 <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_gpu_shader5.txt>`__
8686
* - `GL_EXT_memory_object <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_external_objects.txt>`__
8787
* - `GL_EXT_memory_object_fd <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_external_objects_fd.txt>`__
8888
* - `GL_EXT_multi_draw_arrays <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_multi_draw_arrays.txt>`__
@@ -120,7 +120,7 @@
120120
* - `GL_IMG_read_format <https://registry.khronos.org/OpenGL/extensions/IMG/IMG_read_format.txt>`__
121121
* - `GL_IMG_shader_binary <https://registry.khronos.org/OpenGL/extensions/IMG/IMG_shader_binary.txt>`__
122122
* - `GL_IMG_texture_format_BGRA8888 <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_texture_format_BGRA8888.txt>`__
123-
* - GL_IMG_texture_npot
123+
* - GL_IMG_texture_npot
124124
* - `GL_KHR_blend_equation_advanced <https://registry.khronos.org/OpenGL/extensions/KHR/KHR_blend_equation_advanced.txt>`__
125125
* - `GL_KHR_blend_equation_advanced_coherent <https://registry.khronos.org/OpenGL/extensions/KHR/KHR_blend_equation_advanced_coherent.txt>`__
126126
* - `GL_KHR_debug <https://registry.khronos.org/OpenGL/extensions/KHR/KHR_debug.txt>`__
@@ -164,7 +164,7 @@
164164

165165
All extensions without links are custom IMG extensions.
166166

167-
.. tab:: Vulkan instance extensions
167+
.. tab-item:: Vulkan instance extensions
168168

169169
.. list-table:: Vulkan instance extensions
170170

‎source/linux/Foundational_Components/Graphics/Rogue/_BXS_Extension_List.rst‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
.. tabs::
1+
.. tab-set::
22

3-
.. tab:: EGL client extensions
3+
.. tab-item:: EGL client extensions
44

55
.. list-table:: EGL client extensions
66

@@ -22,7 +22,7 @@
2222

2323
All extensions without links are custom IMG extensions.
2424

25-
.. tab:: EGL extensions
25+
.. tab-item:: EGL extensions
2626

2727
.. list-table:: EGL extensions
2828

@@ -63,7 +63,7 @@
6363

6464
All extensions without links are custom IMG extensions.
6565

66-
.. tab:: GL extensions
66+
.. tab-item:: GL extensions
6767

6868
.. list-table:: GL extensions
6969

@@ -86,7 +86,7 @@
8686
* - `GL_EXT_float_blend <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_float_blend.txt>`__
8787
* - `GL_EXT_geometry_point_size <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_geometry_shader.txt>`__
8888
* - `GL_EXT_geometry_shader <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_geometry_shader.txt>`__
89-
* - `GL_EXT_gpu_shader5 <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_gpu_shader5.txt>`__
89+
* - `GL_EXT_gpu_shader5 <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_gpu_shader5.txt>`__
9090
* - `GL_EXT_memory_object <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_external_objects.txt>`__
9191
* - `GL_EXT_memory_object_fd <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_external_objects_fd.txt>`__
9292
* - `GL_EXT_multi_draw_arrays <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_multi_draw_arrays.txt>`__
@@ -179,7 +179,7 @@
179179

180180
All extensions without links are custom IMG extensions.
181181

182-
.. tab:: Vulkan instance extensions
182+
.. tab-item:: Vulkan instance extensions
183183

184184
.. list-table:: Vulkan instance extensions
185185

‎source/linux/Overview/_Processor_SDK_Building_The_SDK.rst‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -108,9 +108,9 @@ The MACHINE can be set to |__SDK_BUILD_MACHINE__|, for example.
108108
Processor SDK image with Arago + EdgeAI filesystem. See `Build Options`_ for a list of
109109
additional targets.
110110

111-
.. tabs::
111+
.. tab-set::
112112

113-
.. tab:: Build Linux SD card Image
113+
.. tab-item:: Build Linux SD card Image
114114

115115
.. code-block:: console
116116
@@ -121,7 +121,7 @@ The MACHINE can be set to |__SDK_BUILD_MACHINE__|, for example.
121121
$ . conf/setenv
122122
$ MACHINE=am62axx-evm bitbake -k tisdk-edgeai-image
123123
124-
.. tab:: Build RT-Linux SD card Image
124+
.. tab-item:: Build RT-Linux SD card Image
125125

126126
.. code-block:: console
127127
@@ -138,9 +138,9 @@ The MACHINE can be set to |__SDK_BUILD_MACHINE__|, for example.
138138
Processor SDK image with arago filesystem. See `Build Options`_ for a list of
139139
additional targets.
140140

141-
.. tabs::
141+
.. tab-set::
142142

143-
.. tab:: Build Linux SD card Image
143+
.. tab-item:: Build Linux SD card Image
144144

145145
.. code-block:: console
146146
@@ -151,7 +151,7 @@ The MACHINE can be set to |__SDK_BUILD_MACHINE__|, for example.
151151
$ . conf/setenv
152152
$ MACHINE=<machine> bitbake -k tisdk-default-image
153153
154-
.. tab:: Build RT-Linux SD card Image
154+
.. tab-item:: Build RT-Linux SD card Image
155155

156156
.. code-block:: console
157157
@@ -171,9 +171,9 @@ The MACHINE can be set to |__SDK_BUILD_MACHINE__|, for example.
171171

172172
* :file:`tisdk-jailhouse-image` is not applicable for am62xxsip-evm and beagleplay-ti.
173173

174-
.. tabs::
174+
.. tab-set::
175175

176-
.. tab:: Build Jailhouse Linux SD card Image
176+
.. tab-item:: Build Jailhouse Linux SD card Image
177177

178178
.. code-block:: console
179179
@@ -185,7 +185,7 @@ The MACHINE can be set to |__SDK_BUILD_MACHINE__|, for example.
185185
$ echo 'TI_EXTRAS="tie-jailhouse"' >> conf/local.conf
186186
$ MACHINE=<machine> bitbake -k tisdk-jailhouse-image
187187
188-
.. tab:: Build Jailhouse RT-Linux SD card Image
188+
.. tab-item:: Build Jailhouse RT-Linux SD card Image
189189

190190
.. code-block:: console
191191

0 commit comments

Comments
 (0)