diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml index 061a1d992..6b61893d7 100644 --- a/.github/workflows/docker.yml +++ b/.github/workflows/docker.yml @@ -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: diff --git a/.rstcheck.cfg b/.rstcheck.cfg index cef15ebdf..3c3e4dfd8 100644 --- a/.rstcheck.cfg +++ b/.rstcheck.cfg @@ -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++ diff --git a/conf.py b/conf.py index 4270352f0..c84b2b8c9 100644 --- a/conf.py +++ b/conf.py @@ -41,7 +41,7 @@ 'sphinx.ext.ifconfig', 'sphinx.ext.graphviz', 'sphinx_rtd_theme', - 'sphinx_tabs.tabs', + 'sphinx_design', 'sphinx_copybutton' ] diff --git a/docker/.gitignore b/docker/.gitignore deleted file mode 100644 index 4414fc1e2..000000000 --- a/docker/.gitignore +++ /dev/null @@ -1 +0,0 @@ -requirements.txt diff --git a/docker/Makefile b/docker/Makefile index 3a48b335f..37a07bc8c 100644 --- a/docker/Makefile +++ b/docker/Makefile @@ -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 . diff --git a/docker/requirements.in b/docker/requirements.in new file mode 100644 index 000000000..195f435ba --- /dev/null +++ b/docker/requirements.in @@ -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 diff --git a/docker/requirements.txt b/docker/requirements.txt new file mode 100644 index 000000000..cc9502a82 --- /dev/null +++ b/docker/requirements.txt @@ -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 diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index b19d51ce5..000000000 --- a/requirements.txt +++ /dev/null @@ -1,40 +0,0 @@ -alabaster==1.0.0 -annotated-types==0.7.0 -babel==2.17.0 -certifi==2025.1.31 -charset-normalizer==3.4.1 -click==8.1.8 -docutils==0.21.2 -idna==3.10 -imagesize==1.4.1 -Jinja2==3.1.5 -lxml==6.0.0 -markdown-it-py==3.0.0 -MarkupSafe==3.0.2 -mdurl==0.1.2 -packaging==24.2 -pillow==11.1.0 -pydantic==2.10.6 -pydantic_core==2.27.2 -Pygments==2.19.1 -requests==2.32.3 -rich==13.9.4 -roman-numerals-py==3.1.0 -rstcheck==6.2.4 -rstcheck-core @ git+https://github.com/StaticRocket/rstcheck-core.git@b7bdfd920a023e24ffe5e560c706954656c366f0 -shellingham==1.5.4 -snowballstemmer==2.2.0 -Sphinx==8.2.3 -sphinx-copybutton==0.5.2 -sphinx-rtd-theme==3.0.2 -sphinx-tabs==3.4.7 -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.15.2 -typing_extensions==4.12.2 -urllib3==2.3.0 diff --git a/source/linux/Foundational_Components/Graphics/Rogue/_8XE_Extension_List.rst b/source/linux/Foundational_Components/Graphics/Rogue/_8XE_Extension_List.rst index 88fe7def2..b8019d181 100644 --- a/source/linux/Foundational_Components/Graphics/Rogue/_8XE_Extension_List.rst +++ b/source/linux/Foundational_Components/Graphics/Rogue/_8XE_Extension_List.rst @@ -1,6 +1,6 @@ -.. tabs:: +.. tab-set:: - .. tab:: EGL client extensions + .. tab-item:: EGL client extensions .. list-table:: EGL client extensions @@ -15,7 +15,7 @@ All extensions without links are custom IMG extensions. - .. tab:: EGL extensions + .. tab-item:: EGL extensions .. list-table:: EGL extensions @@ -43,13 +43,13 @@ * - `EGL_MESA_drm_image `__ * - `EGL_MESA_image_dma_buf_export `__ * - `EGL_WL_bind_wayland_display `__ - * - 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 @@ -68,7 +68,7 @@ * - `GL_EXT_float_blend `__ * - `GL_EXT_geometry_point_size `__ * - `GL_EXT_geometry_shader `__ - * - `GL_EXT_gpu_shader5 `__ + * - `GL_EXT_gpu_shader5 `__ * - `GL_EXT_memory_object `__ * - `GL_EXT_multisampled_render_to_texture `__ * - `GL_EXT_multisampled_render_to_texture2 `__ @@ -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 @@ -184,7 +184,7 @@ * - `VK_EXT_debug_report `__ - v10 * - `VK_EXT_debug_utils `__ - - v2 + - v2 .. note:: diff --git a/source/linux/Foundational_Components/Graphics/Rogue/_AXE_Extension_List.rst b/source/linux/Foundational_Components/Graphics/Rogue/_AXE_Extension_List.rst index facdc7bb3..41339666a 100644 --- a/source/linux/Foundational_Components/Graphics/Rogue/_AXE_Extension_List.rst +++ b/source/linux/Foundational_Components/Graphics/Rogue/_AXE_Extension_List.rst @@ -1,6 +1,6 @@ -.. tabs:: +.. tab-set:: - .. tab:: EGL client extensions + .. tab-item:: EGL client extensions .. list-table:: EGL client extensions @@ -22,7 +22,7 @@ All extensions without links are custom IMG extensions. - .. tab:: EGL extensions + .. tab-item:: EGL extensions .. list-table:: EGL extensions @@ -57,13 +57,13 @@ * - `EGL_MESA_image_dma_buf_export `__ * - `EGL_WL_bind_wayland_display `__ * - `EGL_WL_create_wayland_buffer_from_image `__ - * - 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 @@ -82,7 +82,7 @@ * - `GL_EXT_draw_elements_base_vertex `__ * - `GL_EXT_EGL_image_array `__ * - `GL_EXT_float_blend `__ - * - `GL_EXT_gpu_shader5 `__ + * - `GL_EXT_gpu_shader5 `__ * - `GL_EXT_memory_object `__ * - `GL_EXT_memory_object_fd `__ * - `GL_EXT_multi_draw_arrays `__ @@ -120,7 +120,7 @@ * - `GL_IMG_read_format `__ * - `GL_IMG_shader_binary `__ * - `GL_IMG_texture_format_BGRA8888 `__ - * - GL_IMG_texture_npot + * - GL_IMG_texture_npot * - `GL_KHR_blend_equation_advanced `__ * - `GL_KHR_blend_equation_advanced_coherent `__ * - `GL_KHR_debug `__ @@ -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 diff --git a/source/linux/Foundational_Components/Graphics/Rogue/_BXS_Extension_List.rst b/source/linux/Foundational_Components/Graphics/Rogue/_BXS_Extension_List.rst index b65cecba9..a1db7973c 100644 --- a/source/linux/Foundational_Components/Graphics/Rogue/_BXS_Extension_List.rst +++ b/source/linux/Foundational_Components/Graphics/Rogue/_BXS_Extension_List.rst @@ -1,6 +1,6 @@ -.. tabs:: +.. tab-set:: - .. tab:: EGL client extensions + .. tab-item:: EGL client extensions .. list-table:: EGL client extensions @@ -22,7 +22,7 @@ All extensions without links are custom IMG extensions. - .. tab:: EGL extensions + .. tab-item:: EGL extensions .. list-table:: EGL extensions @@ -63,7 +63,7 @@ All extensions without links are custom IMG extensions. - .. tab:: GL extensions + .. tab-item:: GL extensions .. list-table:: GL extensions @@ -86,7 +86,7 @@ * - `GL_EXT_float_blend `__ * - `GL_EXT_geometry_point_size `__ * - `GL_EXT_geometry_shader `__ - * - `GL_EXT_gpu_shader5 `__ + * - `GL_EXT_gpu_shader5 `__ * - `GL_EXT_memory_object `__ * - `GL_EXT_memory_object_fd `__ * - `GL_EXT_multi_draw_arrays `__ @@ -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 diff --git a/source/linux/Overview/_Processor_SDK_Building_The_SDK.rst b/source/linux/Overview/_Processor_SDK_Building_The_SDK.rst index f680f0312..9965fe3b0 100644 --- a/source/linux/Overview/_Processor_SDK_Building_The_SDK.rst +++ b/source/linux/Overview/_Processor_SDK_Building_The_SDK.rst @@ -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 @@ -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 @@ -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 @@ -151,7 +151,7 @@ The MACHINE can be set to |__SDK_BUILD_MACHINE__|, for example. $ . conf/setenv $ MACHINE= bitbake -k tisdk-default-image - .. tab:: Build RT-Linux SD card Image + .. tab-item:: Build RT-Linux SD card Image .. code-block:: console @@ -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 @@ -185,7 +185,7 @@ The MACHINE can be set to |__SDK_BUILD_MACHINE__|, for example. $ echo 'TI_EXTRAS="tie-jailhouse"' >> conf/local.conf $ 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