Skip to content

Commit

Permalink
render extends in the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lukaspie committed Feb 12, 2025
1 parent f44d1b1 commit 02d917b
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion dev_tools/docs/nxdl.py
Original file line number Diff line number Diff line change
Expand Up @@ -587,7 +587,6 @@ def _print_doc_enum(self, indent, ns, node, required=False):
self._print_enumeration(
collapse_indent + self._INDENTATION_UNIT, ns, node_list[0]
)

def _print_attribute(self, ns, kind, node, optional, indent, parent_path):
name = node.get("name")
formatted_name = get_rst_formatted_name(node)
Expand All @@ -601,6 +600,13 @@ def _print_attribute(self, ns, kind, node, optional, indent, parent_path):
)
self._print_doc_enum(indent, ns, node)


def _print_extends_text(self, ns, node, indent):
extends_text = node.get("extends", None)
if extends_text is not None:
# self._print(f"\n{indent}.. index:: deprecated\n")
self._print(f"\n{indent}This field extends: {extends_text}\n")

def _print_if_deprecated(self, ns, node, indent):
deprecated = node.get("deprecated", None)
if deprecated is not None:
Expand Down Expand Up @@ -636,6 +642,7 @@ def _print_full_tree(self, ns, parent, name, indent, parent_path):
"\n"
)

self._print_extends_text(ns, node, indent + self._INDENTATION_UNIT)
self._print_if_deprecated(ns, node, indent + self._INDENTATION_UNIT)
self._print_doc_enum(indent, ns, node)

Expand Down

0 comments on commit 02d917b

Please sign in to comment.