Skip to content

Add support for field xrefs #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sjalloq wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add support for field xrefs #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/sphinx_peakrdl/directives/docnode.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,10 @@ def make_rdl_reg_doc(self, rdl_node: RegNode) -> Sequence[nodes.Element]:
if not desc:
continue

field_ref_id = field.get_path(array_suffix="", empty_array_suffix="")

dli = nodes.definition_list_item()
dli["ids"] = [field_ref_id]
def_list.append(dli)

dl_term = nodes.term(text = field.inst_name)
Expand All @@ -271,6 +274,9 @@ def make_rdl_reg_doc(self, rdl_node: RegNode) -> Sequence[nodes.Element]:
dli.append(dl_term)
dli.append(dl_def)

# Register field as a linkable docnode
self.domain.data["rdl_docnodes"][field_ref_id] = self.env.docname

return [fl, desc_paragraph, table.as_node(), def_list]


Expand Down