diff --git a/conf.py b/conf.py index 230f0d62d..02bd16202 100644 --- a/conf.py +++ b/conf.py @@ -16,6 +16,7 @@ import sys import os import importlib +import json from datetime import datetime # If extensions (or modules to document with autodoc) are in another directory, @@ -36,6 +37,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + 'sphinx.ext.extlinks', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.mathjax', @@ -258,6 +260,10 @@ # Suppress warnings about excluded documents because every device gets a different toc tree suppress_warnings = ['toc.excluded'] +# Load extlinks config +with open(os.path.join(rootdir, 'extlinks.json'), 'r', encoding='utf-8') as extconf: + extlinks = json.load(extconf) + # -- Tag file loader ------------------------------------------------------ FAMILY = os.environ.get("DEVFAMILY", "") diff --git a/extlinks.json b/extlinks.json new file mode 100644 index 000000000..44dd68ffc --- /dev/null +++ b/extlinks.json @@ -0,0 +1,6 @@ +{ + "ti-linux-kernel-binding": [ + "https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/Documentation/devicetree/bindings/%s?h=ti-linux-6.12.y", + "Documentation/devicetree/bindings/%s" + ] +} diff --git a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst index 7419cf790..4b82d8227 100644 --- a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst +++ b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst @@ -309,7 +309,7 @@ Note: this is not a comprehensive list of features supported/not supported, and .. ifconfig:: CONFIG_part_variant in ('AM62PX', 'J722S') More detailed description of these properties can be found at: - `Display device-tree file `__ + :ti-linux-kernel-binding:`Display device-tree file `__ diff --git a/source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet.rst b/source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet.rst index 45921aa5d..7ccc6b076 100644 --- a/source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet.rst +++ b/source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet.rst @@ -81,9 +81,8 @@ Device tree bindings The DT bindings description can be found at: -| `Documentation/devicetree/bindings/net/ti,icssg-prueth.yaml `__ -| `Documentation/devicetree/bindings/net/ti,davinci-mdio.yaml `__ -| +:ti-linux-kernel-binding:`net/ti,icssg-prueth.yaml` +:ti-linux-kernel-binding:`net/ti,davinci-mdio.yaml` User guide ########## diff --git a/source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet_sr10.rst b/source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet_sr10.rst index 4d813a6ce..3791429ce 100644 --- a/source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet_sr10.rst +++ b/source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet_sr10.rst @@ -68,8 +68,7 @@ Device tree bindings The DT bindings description can be found at: -| `Documentation/devicetree/bindings/net/ti,icssg-prueth.txt `__ -| +:ti-linux-kernel-binding:`net/ti,icssg-prueth.txt` User guide ########## diff --git a/source/linux/Foundational_Components_IPC62ax.rst b/source/linux/Foundational_Components_IPC62ax.rst index f3065c53f..706f4e40f 100644 --- a/source/linux/Foundational_Components_IPC62ax.rst +++ b/source/linux/Foundational_Components_IPC62ax.rst @@ -164,7 +164,8 @@ System memory is carved out for each remote processor core for IPC and for the remote processor's code/data section needs. The default memory carveouts (DMA pools) are shown below. -See the devicetree bindings documentation for more details: `Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml `__ +See the devicetree bindings documentation for more details: +:ti-linux-kernel-binding:`remoteproc/ti,k3-r5f-rproc.yaml` :: diff --git a/source/linux/Foundational_Components_IPC62px.rst b/source/linux/Foundational_Components_IPC62px.rst index 2bff706a0..eaaa0f179 100644 --- a/source/linux/Foundational_Components_IPC62px.rst +++ b/source/linux/Foundational_Components_IPC62px.rst @@ -155,7 +155,8 @@ System memory is carved out for each remote processor core for IPC and for the remote processor's code/data section needs. The default memory carveouts (DMA pools) are shown below. -See the devicetree bindings documentation for more details: `Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml `__ +See the devicetree bindings documentation for more details: +:ti-linux-kernel-binding:`remoteproc/ti,k3-r5f-rproc.yaml` +------------------+--------------------+---------+----------------------------+ | Memory Section | Physical Address | Size | Description | diff --git a/source/linux/Foundational_Components_IPC62x.rst b/source/linux/Foundational_Components_IPC62x.rst index 772250f39..cc550e89d 100644 --- a/source/linux/Foundational_Components_IPC62x.rst +++ b/source/linux/Foundational_Components_IPC62x.rst @@ -158,7 +158,8 @@ System memory is carved out for each remote processor core for IPC and for the remote processor's code/data section needs. The default memory carveouts (DMA pools) are shown below. -See the devicetree bindings documentation for more details: `Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml `__ +See the devicetree bindings documentation for more details: +:ti-linux-kernel-binding:`remoteproc/ti,k3-r5f-rproc.yaml` +------------------+--------------------+---------+----------------------------+ | Memory Section | Physical Address | Size | Description | diff --git a/source/linux/Foundational_Components_IPC64x.rst b/source/linux/Foundational_Components_IPC64x.rst index ce4182a77..336f62f7c 100644 --- a/source/linux/Foundational_Components_IPC64x.rst +++ b/source/linux/Foundational_Components_IPC64x.rst @@ -163,7 +163,7 @@ R5F subsystems are operating in Split mode. If an R5F subsystem is run in Single-CPU mode, then R5F Core0 continues to use memory carveouts. However, R5F Core1 is unused in Single-CPU mode, so the Core1 memory carveouts can be reallocated to other cores. See the devicetree bindings documentation for more -details: `Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml `__ +details: :ti-linux-kernel-binding:`remoteproc/ti,k3-r5f-rproc.yaml` :: diff --git a/source/linux/Foundational_Components_IPC_J7200.rst b/source/linux/Foundational_Components_IPC_J7200.rst index d6f738647..b978a7b1a 100644 --- a/source/linux/Foundational_Components_IPC_J7200.rst +++ b/source/linux/Foundational_Components_IPC_J7200.rst @@ -152,7 +152,8 @@ System memory is carved out for each remote processor core for IPC and for the remote processor's code/data section needs. The default memory carveouts (DMA pools) are shown below. -See the devicetree bindings documentation for more details: `Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml `__ +See the devicetree bindings documentation for more details: +:ti-linux-kernel-binding:`remoteproc/ti,k3-r5f-rproc.yaml` .. code-block:: text diff --git a/source/linux/Foundational_Components_IPC_J721E.rst b/source/linux/Foundational_Components_IPC_J721E.rst index 8991e2423..72682c657 100644 --- a/source/linux/Foundational_Components_IPC_J721E.rst +++ b/source/linux/Foundational_Components_IPC_J721E.rst @@ -224,7 +224,8 @@ System memory is carved out for each remote processor core for IPC and for the remote processor's code/data section needs. The default memory carveouts (DMA pools) are shown below. -See the devicetree bindings documentation for more details: `Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml `__ +See the devicetree bindings documentation for more details: +:ti-linux-kernel-binding:`remoteproc/ti,k3-r5f-rproc.yaml` .. code-block:: text diff --git a/source/linux/Foundational_Components_IPC_J721S2.rst b/source/linux/Foundational_Components_IPC_J721S2.rst index 61f08eb08..5bd79e943 100644 --- a/source/linux/Foundational_Components_IPC_J721S2.rst +++ b/source/linux/Foundational_Components_IPC_J721S2.rst @@ -178,7 +178,8 @@ System memory is carved out for each remote processor core for IPC and for the remote processor's code/data section needs. The default memory carveouts (DMA pools) are shown below. -See the devicetree bindings documentation for more details: `Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml `__ +See the devicetree bindings documentation for more details: +:ti-linux-kernel-binding:`remoteproc/ti,k3-r5f-rproc.yaml` .. code-block:: text diff --git a/source/linux/Foundational_Components_IPC_J722S.rst b/source/linux/Foundational_Components_IPC_J722S.rst index 5c11423f3..bc09228a3 100644 --- a/source/linux/Foundational_Components_IPC_J722S.rst +++ b/source/linux/Foundational_Components_IPC_J722S.rst @@ -158,7 +158,8 @@ System memory is carved out for each remote processor core for IPC and for the remote processor's code/data section needs. The default memory carveouts (DMA pools) are shown below. -See the devicetree bindings documentation for more details: `Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml `__ +See the devicetree bindings documentation for more details: +:ti-linux-kernel-binding:`remoteproc/ti,k3-r5f-rproc.yaml` .. code-block:: text diff --git a/source/linux/Foundational_Components_IPC_J742S2.rst b/source/linux/Foundational_Components_IPC_J742S2.rst index 98af37bbb..b9722ccb4 100644 --- a/source/linux/Foundational_Components_IPC_J742S2.rst +++ b/source/linux/Foundational_Components_IPC_J742S2.rst @@ -195,7 +195,8 @@ System memory is carved out for each remote processor core for IPC and for the remote processor's code/data section needs. The default memory carveouts (DMA pools) are shown below. -See the devicetree bindings documentation for more details: `Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml `__ +See the devicetree bindings documentation for more details: +:ti-linux-kernel-binding:`remoteproc/ti,k3-r5f-rproc.yaml` .. code-block:: text diff --git a/source/linux/Foundational_Components_IPC_J784S4.rst b/source/linux/Foundational_Components_IPC_J784S4.rst index 79461d059..5a2cbde5c 100644 --- a/source/linux/Foundational_Components_IPC_J784S4.rst +++ b/source/linux/Foundational_Components_IPC_J784S4.rst @@ -201,7 +201,8 @@ System memory is carved out for each remote processor core for IPC and for the remote processor's code/data section needs. The default memory carveouts (DMA pools) are shown below. -See the devicetree bindings documentation for more details: `Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml `__ +See the devicetree bindings documentation for more details: +:ti-linux-kernel-binding:`remoteproc/ti,k3-r5f-rproc.yaml` .. code-block:: text