Skip to content

Commit b64e696

Browse files
committed
change rendering of extends keyword to inline
1 parent 37f32dc commit b64e696

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

dev_tools/docs/nxdl.py

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -606,12 +606,12 @@ def _print_attribute(self, ns, kind, node, optional, indent, parent_path):
606606
f"{indent}{formatted_name}: {optional}{self._format_type(node)}{self._format_units(node)} {self.get_first_parent_ref(f'{parent_path}/{name}', 'attribute')}\n"
607607
)
608608
self._print_doc_enum(indent, ns, node)
609-
610-
def _print_extends_text(self, ns, node, indent):
611-
extends_text = node.get("extends", None)
612-
if extends_text is not None:
613-
# self._print(f"\n{indent}.. index:: deprecated\n")
614-
self._print(f"\n{indent}This field extends: {extends_text}\n")
609+
610+
def _get_extends_text(self, node):
611+
extends = node.get("extends", None)
612+
if extends:
613+
return f"(:ref:`{extends.split("/")[-1]} <{extends}-field>`) "
614+
return ""
615615

616616
def _print_if_deprecated(self, ns, node, indent):
617617
deprecated = node.get("deprecated", None)
@@ -636,19 +636,20 @@ def _print_full_tree(self, ns, parent, name, indent, parent_path):
636636
dims = self._analyze_dimensions(ns, node)
637637

638638
optional_text = self._get_required_or_optional_text(node)
639+
extends_test = self._get_extends_text(node)
639640
self._print(f"{indent}{self._hyperlink_target(parent_path, name, 'field')}")
640641
self._print(f"{indent}.. index:: {index_name} (field)\n")
641642
self._print(
642643
f"{indent}{formatted_name}: "
643644
f"{optional_text}"
645+
f"{extends_test}"
644646
f"{self._format_type(node)}"
645647
f"{dims}"
646648
f"{self._format_units(node)}"
647649
f" {self.get_first_parent_ref(f'{parent_path}/{name}', 'field')}"
648650
"\n"
649651
)
650-
651-
self._print_extends_text(ns, node, indent + self._INDENTATION_UNIT)
652+
652653
self._print_if_deprecated(ns, node, indent + self._INDENTATION_UNIT)
653654
self._print_doc_enum(indent, ns, node)
654655

0 commit comments

Comments
 (0)