Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .github/workflows/docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,6 @@ jobs:
type=sha
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}

- name: Setup context
run: make -C docker setup

- name: Build and push Docker image
uses: docker/build-push-action@v5
with:
Expand Down
2 changes: 1 addition & 1 deletion .rstcheck.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[rstcheck]
ignore_directives = ifconfig,tabs,tab,group-tab,code-tab,graphviz
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
# ignore the following languages because they require external compilers and
# snippets in this repo depend on external code
ignore_languages = c,cpp,c++
Expand Down
2 changes: 1 addition & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
'sphinx.ext.ifconfig',
'sphinx.ext.graphviz',
'sphinx_rtd_theme',
'sphinx_tabs.tabs',
'sphinx_design',
'sphinx_copybutton'
]

Expand Down
1 change: 0 additions & 1 deletion docker/.gitignore

This file was deleted.

9 changes: 2 additions & 7 deletions docker/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,7 @@ ifeq ($(CONTAINER_TOOL),)
endif
endif

.PHONY: all setup
all: Dockerfile setup
.PHONY: all
all: Dockerfile
$(CONTAINER_TOOL) build . -t texasinstruments/processor-sdk-doc \
$(BUILD_ARGS)

setup: requirements.txt

requirements.txt: ../requirements.txt
cp -ar ../requirements.txt .
8 changes: 8 additions & 0 deletions docker/requirements.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Jinja2>=3.1.5
lxml>=6.0.0
rstcheck==6.2.5
rstcheck-core @ git+https://github.com/StaticRocket/rstcheck-core.git@d935498cfc319d62fe2dde3012d81657510f0a90
Sphinx>=8.2.3
sphinx-copybutton>=0.5.2
sphinx_design>=0.7.0
sphinx-rtd-theme>=3.0.2
40 changes: 40 additions & 0 deletions docker/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
alabaster==1.0.0
annotated-doc==0.0.4
annotated-types==0.7.0
babel==2.18.0
certifi==2026.5.20
charset-normalizer==3.4.7
docutils==0.22.4
idna==3.18
imagesize==2.0.0
Jinja2==3.1.6
lxml==6.1.1
markdown-it-py==4.2.0
MarkupSafe==3.0.3
mdurl==0.1.2
packaging==26.2
pydantic==2.13.4
pydantic_core==2.46.4
Pygments==2.20.0
requests==2.34.2
rich==15.0.0
roman-numerals==4.1.0
rstcheck==6.2.5
rstcheck-core @ git+https://github.com/StaticRocket/rstcheck-core.git@d935498cfc319d62fe2dde3012d81657510f0a90
shellingham==1.5.4
snowballstemmer==3.1.1
Sphinx==9.1.0
sphinx-copybutton==0.5.2
sphinx_design==0.7.0
sphinx_rtd_theme==3.1.0
sphinxcontrib-applehelp==2.0.0
sphinxcontrib-devhelp==2.0.0
sphinxcontrib-htmlhelp==2.1.0
sphinxcontrib-jquery==4.1
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==2.0.0
sphinxcontrib-serializinghtml==2.0.0
typer==0.26.7
typing-inspection==0.4.2
typing_extensions==4.15.0
urllib3==2.7.0
40 changes: 0 additions & 40 deletions requirements.txt

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. tabs::
.. tab-set::

.. tab:: EGL client extensions
.. tab-item:: EGL client extensions

.. list-table:: EGL client extensions

Expand All @@ -15,7 +15,7 @@

All extensions without links are custom IMG extensions.

.. tab:: EGL extensions
.. tab-item:: EGL extensions

.. list-table:: EGL extensions

Expand Down Expand Up @@ -43,13 +43,13 @@
* - `EGL_MESA_drm_image <https://registry.khronos.org/EGL/extensions/MESA/EGL_MESA_drm_image.txt>`__
* - `EGL_MESA_image_dma_buf_export <https://registry.khronos.org/EGL/extensions/MESA/EGL_MESA_image_dma_buf_export.txt>`__
* - `EGL_WL_bind_wayland_display <https://registry.khronos.org/EGL/extensions/WL/EGL_WL_bind_wayland_display.txt>`__
* - EGL_IMG_cl_image
* - EGL_IMG_cl_image

.. note::

All extensions without links are custom IMG extensions.

.. tab:: GL extensions
.. tab-item:: GL extensions

.. list-table:: GL extensions

Expand All @@ -68,7 +68,7 @@
* - `GL_EXT_float_blend <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_float_blend.txt>`__
* - `GL_EXT_geometry_point_size <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_geometry_shader.txt>`__
* - `GL_EXT_geometry_shader <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_geometry_shader.txt>`__
* - `GL_EXT_gpu_shader5 <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_gpu_shader5.txt>`__
* - `GL_EXT_gpu_shader5 <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_gpu_shader5.txt>`__
* - `GL_EXT_memory_object <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_external_objects.txt>`__
* - `GL_EXT_multisampled_render_to_texture <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_multisampled_render_to_texture.txt>`__
* - `GL_EXT_multisampled_render_to_texture2 <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_multisampled_render_to_texture2.txt>`__
Expand Down Expand Up @@ -157,7 +157,7 @@

All extensions without links are custom IMG extensions.

.. tab:: Vulkan instance extensions
.. tab-item:: Vulkan instance extensions

.. list-table:: Vulkan instance extensions

Expand All @@ -184,7 +184,7 @@
* - `VK_EXT_debug_report <https://docs.vulkan.org/refpages/latest/refpages/source/VK_EXT_debug_report.html>`__
- v10
* - `VK_EXT_debug_utils <https://docs.vulkan.org/refpages/latest/refpages/source/VK_EXT_debug_utils.html>`__
- v2
- v2

.. note::

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. tabs::
.. tab-set::

.. tab:: EGL client extensions
.. tab-item:: EGL client extensions

.. list-table:: EGL client extensions

Expand All @@ -22,7 +22,7 @@

All extensions without links are custom IMG extensions.

.. tab:: EGL extensions
.. tab-item:: EGL extensions

.. list-table:: EGL extensions

Expand Down Expand Up @@ -57,13 +57,13 @@
* - `EGL_MESA_image_dma_buf_export <https://registry.khronos.org/EGL/extensions/MESA/EGL_MESA_image_dma_buf_export.txt>`__
* - `EGL_WL_bind_wayland_display <https://registry.khronos.org/EGL/extensions/WL/EGL_WL_bind_wayland_display.txt>`__
* - `EGL_WL_create_wayland_buffer_from_image <https://registry.khronos.org/EGL/extensions/WL/EGL_WL_create_wayland_buffer_from_image.txt>`__
* - EGL_IMG_cl_image
* - EGL_IMG_cl_image

.. note::

All extensions without links are custom IMG extensions.

.. tab:: GL extensions
.. tab-item:: GL extensions

.. list-table:: GL extensions

Expand All @@ -82,7 +82,7 @@
* - `GL_EXT_draw_elements_base_vertex <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_draw_elements_base_vertex.txt>`__
* - `GL_EXT_EGL_image_array <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_EGL_image_array.txt>`__
* - `GL_EXT_float_blend <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_float_blend.txt>`__
* - `GL_EXT_gpu_shader5 <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_gpu_shader5.txt>`__
* - `GL_EXT_gpu_shader5 <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_gpu_shader5.txt>`__
* - `GL_EXT_memory_object <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_external_objects.txt>`__
* - `GL_EXT_memory_object_fd <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_external_objects_fd.txt>`__
* - `GL_EXT_multi_draw_arrays <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_multi_draw_arrays.txt>`__
Expand Down Expand Up @@ -120,7 +120,7 @@
* - `GL_IMG_read_format <https://registry.khronos.org/OpenGL/extensions/IMG/IMG_read_format.txt>`__
* - `GL_IMG_shader_binary <https://registry.khronos.org/OpenGL/extensions/IMG/IMG_shader_binary.txt>`__
* - `GL_IMG_texture_format_BGRA8888 <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_texture_format_BGRA8888.txt>`__
* - GL_IMG_texture_npot
* - GL_IMG_texture_npot
* - `GL_KHR_blend_equation_advanced <https://registry.khronos.org/OpenGL/extensions/KHR/KHR_blend_equation_advanced.txt>`__
* - `GL_KHR_blend_equation_advanced_coherent <https://registry.khronos.org/OpenGL/extensions/KHR/KHR_blend_equation_advanced_coherent.txt>`__
* - `GL_KHR_debug <https://registry.khronos.org/OpenGL/extensions/KHR/KHR_debug.txt>`__
Expand Down Expand Up @@ -164,7 +164,7 @@

All extensions without links are custom IMG extensions.

.. tab:: Vulkan instance extensions
.. tab-item:: Vulkan instance extensions

.. list-table:: Vulkan instance extensions

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. tabs::
.. tab-set::

.. tab:: EGL client extensions
.. tab-item:: EGL client extensions

.. list-table:: EGL client extensions

Expand All @@ -22,7 +22,7 @@

All extensions without links are custom IMG extensions.

.. tab:: EGL extensions
.. tab-item:: EGL extensions

.. list-table:: EGL extensions

Expand Down Expand Up @@ -63,7 +63,7 @@

All extensions without links are custom IMG extensions.

.. tab:: GL extensions
.. tab-item:: GL extensions

.. list-table:: GL extensions

Expand All @@ -86,7 +86,7 @@
* - `GL_EXT_float_blend <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_float_blend.txt>`__
* - `GL_EXT_geometry_point_size <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_geometry_shader.txt>`__
* - `GL_EXT_geometry_shader <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_geometry_shader.txt>`__
* - `GL_EXT_gpu_shader5 <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_gpu_shader5.txt>`__
* - `GL_EXT_gpu_shader5 <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_gpu_shader5.txt>`__
* - `GL_EXT_memory_object <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_external_objects.txt>`__
* - `GL_EXT_memory_object_fd <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_external_objects_fd.txt>`__
* - `GL_EXT_multi_draw_arrays <https://registry.khronos.org/OpenGL/extensions/EXT/EXT_multi_draw_arrays.txt>`__
Expand Down Expand Up @@ -179,7 +179,7 @@

All extensions without links are custom IMG extensions.

.. tab:: Vulkan instance extensions
.. tab-item:: Vulkan instance extensions

.. list-table:: Vulkan instance extensions

Expand Down
18 changes: 9 additions & 9 deletions source/linux/Overview/_Processor_SDK_Building_The_SDK.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,9 +108,9 @@ The MACHINE can be set to |__SDK_BUILD_MACHINE__|, for example.
Processor SDK image with Arago + EdgeAI filesystem. See `Build Options`_ for a list of
additional targets.

.. tabs::
.. tab-set::

.. tab:: Build Linux SD card Image
.. tab-item:: Build Linux SD card Image

.. code-block:: console

Expand All @@ -121,7 +121,7 @@ The MACHINE can be set to |__SDK_BUILD_MACHINE__|, for example.
$ . conf/setenv
$ MACHINE=am62axx-evm bitbake -k tisdk-edgeai-image

.. tab:: Build RT-Linux SD card Image
.. tab-item:: Build RT-Linux SD card Image

.. code-block:: console

Expand All @@ -138,9 +138,9 @@ The MACHINE can be set to |__SDK_BUILD_MACHINE__|, for example.
Processor SDK image with arago filesystem. See `Build Options`_ for a list of
additional targets.

.. tabs::
.. tab-set::

.. tab:: Build Linux SD card Image
.. tab-item:: Build Linux SD card Image

.. code-block:: console

Expand All @@ -151,7 +151,7 @@ The MACHINE can be set to |__SDK_BUILD_MACHINE__|, for example.
$ . conf/setenv
$ MACHINE=<machine> bitbake -k tisdk-default-image

.. tab:: Build RT-Linux SD card Image
.. tab-item:: Build RT-Linux SD card Image

.. code-block:: console

Expand All @@ -171,9 +171,9 @@ The MACHINE can be set to |__SDK_BUILD_MACHINE__|, for example.

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

.. tabs::
.. tab-set::

.. tab:: Build Jailhouse Linux SD card Image
.. tab-item:: Build Jailhouse Linux SD card Image

.. code-block:: console

Expand All @@ -185,7 +185,7 @@ The MACHINE can be set to |__SDK_BUILD_MACHINE__|, for example.
$ echo 'TI_EXTRAS="tie-jailhouse"' >> conf/local.conf
$ MACHINE=<machine> bitbake -k tisdk-jailhouse-image

.. tab:: Build Jailhouse RT-Linux SD card Image
.. tab-item:: Build Jailhouse RT-Linux SD card Image

.. code-block:: console

Expand Down
Loading