[rtems-central commit] interfacedoc: Substitute brief descriptions

[Sebastian Huber]

Module:    rtems-central
Branch:    master
Commit:    414479f9ef5e75f8f3de1cf7d88670fc7931cf8a
Changeset: http://git.rtems.org/rtems-central/commit/?id=414479f9ef5e75f8f3de1cf7d88670fc7931cf8a

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Wed Feb 10 09:53:21 2021 +0100

interfacedoc: Substitute brief descriptions

---

 rtemsspec/interfacedoc.py | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/rtemsspec/interfacedoc.py b/rtemsspec/interfacedoc.py
index e45fd93..3c575e1 100644
--- a/rtemsspec/interfacedoc.py
+++ b/rtemsspec/interfacedoc.py
@@ -91,7 +91,7 @@ class _Mapper(SphinxMapper):
         return ctx.value[ctx.key]
 
 
-def _generate_introduction(target: str, group: Item,
+def _generate_introduction(target: str, group: Item, group_uids: List[str],
                            items: List[Item]) -> None:
     content = SphinxContent()
     content.register_license_and_copyrights_of_item(group)
@@ -114,7 +114,8 @@ def _generate_introduction(target: str, group: Item,
         for item in items:
             content.register_license_and_copyrights_of_item(item)
             name = item["name"]
-            brief = item["brief"]
+            mapper = _Mapper(item, group_uids)
+            brief = mapper.substitute(item["brief"])
             if brief:
                 brief = f" - {brief}"
             else:
@@ -165,7 +166,7 @@ def _add_definition(content: CContent, mapper: ItemMapper, item: Item,
 
 def _generate_directive(content: SphinxContent, mapper: _Mapper,
                         code_mapper: _CodeMapper, item: Item) -> None:
-    content.wrap(item["brief"])
+    content.wrap(mapper.substitute(item["brief"]))
     content.add(".. rubric:: CALLING SEQUENCE:")
     with content.directive("code-block", "c"):
         code = CContent()
@@ -265,6 +266,7 @@ def generate(config: list, item_cache: ItemCache) -> None:
                 items.append(child)
         items.sort(key=functools.partial(
             _directive_key, list(group.parents("placement-order"))))
-        _generate_introduction(doc_config["introduction-target"], group, items)
+        _generate_introduction(doc_config["introduction-target"], group,
+                               group_uids, items)
         _generate_directives(doc_config["directives-target"], group,
                              group_uids, items)