Skip to content

Commit 8641fea

Browse files
authored
fix: scripts/generate_facts_docs: add canonical-name label for re-exported facts (#1686)
1 parent 989b902 commit 8641fea

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

scripts/generate_facts_docs.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,13 @@ def build_facts_docs():
104104
)
105105

106106
lines.append(".. _facts:{0}.{1}:".format(module_name, name))
107+
# Modules that re-export classes under an alias (e.g. facts/zfs.py
108+
# exposes both ZfsDatasets and Datasets pointing at the same class)
109+
# end up keyed by whichever name getmembers sees first. Emit the
110+
# canonical class name as an extra label so cross-refs from the
111+
# operations docs resolve regardless of import style.
112+
if cls.__name__ != name:
113+
lines.append(".. _facts:{0}.{1}:".format(module_name, cls.__name__))
107114
lines.append("")
108115

109116
title = ":code:`{0}.{1}`".format(module_name, name)

0 commit comments

Comments
 (0)