diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2023-05-05 14:41:19 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2023-05-08 21:58:56 +0200 |
| commit | 88b0abcb62c2048c1408edf3a4e641192e44f54d (patch) | |
| tree | 2bd8920415e00ccf691da331db0eafa3db08d2e7 | |
| parent | interfacedoc: Add document_directive() (diff) | |
| download | rtems-central-88b0abcb62c2048c1408edf3a4e641192e44f54d.tar.bz2 | |
interfacedoc: Make CodeMapper public
| -rw-r--r-- | rtemsspec/interfacedoc.py | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/rtemsspec/interfacedoc.py b/rtemsspec/interfacedoc.py index 880e4e63..02242227 100644 --- a/rtemsspec/interfacedoc.py +++ b/rtemsspec/interfacedoc.py @@ -47,7 +47,8 @@ def _get_code_param(ctx: ItemGetValueContext) -> Any: return sanitize_name(ctx.value[ctx.key]) -class _CodeMapper(ItemMapper): +class CodeMapper(ItemMapper): + """ Item mapper for code blocks. """ def __init__(self, item: Item): super().__init__(item) @@ -128,7 +129,7 @@ def _add_definition(content: CContent, mapper: ItemMapper, item: Item, def _document_directive(content: SphinxContent, mapper: ItemMapper, - code_mapper: _CodeMapper, item: Item, + code_mapper: CodeMapper, item: Item, enabled: List[str]) -> None: content.wrap(mapper.substitute(item["brief"])) content.add_rubric("CALLING SEQUENCE:") @@ -182,7 +183,7 @@ def document_directive(item: Item, enabled: List[str], enabled set. """ content = SphinxContent() - _document_directive(content, mapper, _CodeMapper(item), item, enabled) + _document_directive(content, mapper, CodeMapper(item), item, enabled) return content @@ -203,7 +204,7 @@ def _generate_directives(target: str, group: Item, group_uids: List[str], for item in items: content.register_license_and_copyrights_of_item(item) name = item["name"] - code_mapper = _CodeMapper(item) + code_mapper = CodeMapper(item) mapper = SphinxInterfaceMapper(item, group_uids) content.add(f".. Generated from spec:{item.uid}") with content.directive("raw", "latex"): |