Using the docnode directive

Contents

Using the docnode directive#

Tip

To view the source of this document, click the “Show Source” option under the GitHub menu button on this page’s header.

The rdl:docnode directive can be used to insert the content of a single register model node into a document.

For example, one could insert the reference for the top-level SoC address layout using …

.. rdl:docnode:: my_soc
    :link-to: doc

… which produces the following output:


my_soc#

Path:

my_soc

Absolute Address:

0x0

This is an example SoC that has three very high-tech peripherals.

Offset

Identifier

Name

0x1000

thingamabob

-

0x2000

uart

-

0x10000

turboencabulator

Turbo-Encabulator