Configuring

Configuring#

Note

Unless specified otherwise, all relative file paths used in config options are interpreted as relative to the enclosing conf.py.

PeakRDL compilation settings#

peakrdl_cfg_toml#
Type:
str

Optional path to a PeakRDL configuration TOML file. This is equivalent to the peakrdl command-line tool’s --peakrdl-cfg flag.

If not specified, a PeakRDL TOML config file is discovered using the same rules as the command-line tool.

peakrdl_input_files#
Type:
list[str]

List of input files to process. Files shall be listed in dependency-order to ensure child components declared before instantiated.

peakrdl_incdirs#
Type:
list[str]

List of additional include search paths.

peakrdl_parameters#
Type:
dict[str, Any]

Dictionary of parameters to pass to the top-level component when elaborating.

Example:

peakrdl_parameters = {
    "N_CHANNELS": 16,
    "BLOCK_VERSION_STR": "v1.2.3",
}
peakrdl_defines#
Type:
dict[str, str|None]

Dictionary of verilog-style define macros to inject into the SystemRDL preprocesor namespace.

Assigning a macro None is acceptable if novalue is needed.

Example:

peakrdl_defines = {
    "FOO": "asdf",
    "BAR": None,
}
peakrdl_top_component#
Type:
str

Explicitly choose which addrmap in the root namespace will be the top-level component. If unset, The last addrmap defined will be chosen.

Cross-reference settings#

Type:
str
Default:
"html"

Configures what the default behavior is for register map cross-references. If not explicitly specified, behavior is determined by this setting.

“html”

Link to PeakRDL-HTML output

“doc”

Link to an inline documentation reference generated by either the rdl:docnode or rdl:doctree directives.

Note

If “doc” is selected, but a corresponding target node was never inserted using rdl:docnode or rdl:doctree, the reference will attempt to link to the PeakRDL html output if available.

PeakRDL-HTML output settings#

peakrdl_html_enable#
Type:
str
Default:
True
peakrdl_html_title#
Type:
str

Override the title text for the PeakRDL-HTML output.

peakrdl_html_extra_doc_properties#
Type:
list[str]

List of additional properties to explicitly document.

Nodes that have a property explicitly set will show its value in a table in the node’s description. Use this to bring forward user-defined properties, or other built-in properties in your documentation.

Inline docnode/doctree settings#

peakrdl_doc_wrap_section#
Type:
bool
Default:
True

Whether to wrap rdl:docnode output in a section heading.

Configures the default behavior for all rdl:docnode directives. If not explicitly specified, behavior is determined by this setting.

Note

Cross-references will not be able to link to a rdl:docnode if it is not wrapped in a section heading.