Inline Documentation#
Register reference can be inserted inline into any reStructuredText document using the directives described in this page. Inline register reference is useful if you do not want to rely on the dynamic HTML-generated register reference, and instead want to have all the register reference be included within the Sphinx-doc project. This is especially useful if the desired output is PDF.
- .. rdl:docnode:: path#
Inserts the full documentation for the register model node referenced by
path.Options
- :wrap-section::#
If set, wraps the content in a section heading. If this option is not specified, behavior is determined by the
peakrdl_doc_wrap_sectionsetting.
- :no-wrap-section::#
If set, suppresses creation of a section heading. This is useful if you want to provide your own section heading fot this docnode.
If this option is not specified, behavior is determined by the
peakrdl_doc_wrap_sectionsetting.
- :link-to::#
Overrides the link taret preference.
- “html”
Link to PeakRDL-HTML output
- “doc”
Link to an inline documentation reference, if it exists.
- .. rdl:doctree:: path#
Similar to the
rdl:docnodedirective, except that this will also generate all child docnodes recursively.Options
- :link-to::#
Overrides the link taret preference.
- “html”
Link to PeakRDL-HTML output
- “doc”
Link to an inline documentation reference, if it exists.