summaryrefslogtreecommitdiffstats
path: root/rtemsqual/sphinxcontent.py
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-06-16 17:17:09 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-07-03 10:22:45 +0200
commitb93290d89f3a08d6352fe025956faaeccf4f6a81 (patch)
tree3709326103a128d53c8a2f95665af75e9c9b9940 /rtemsqual/sphinxcontent.py
parentsphinxcontent: Add SphinxContent.definition_item() (diff)
downloadrtems-central-b93290d89f3a08d6352fe025956faaeccf4f6a81.tar.bz2
sphinxcontent: Optional wrap in add_definition_item()
Diffstat (limited to 'rtemsqual/sphinxcontent.py')
-rw-r--r--rtemsqual/sphinxcontent.py10
1 files changed, 8 insertions, 2 deletions
diff --git a/rtemsqual/sphinxcontent.py b/rtemsqual/sphinxcontent.py
index 3bec4e04..95f8438c 100644
--- a/rtemsqual/sphinxcontent.py
+++ b/rtemsqual/sphinxcontent.py
@@ -92,7 +92,10 @@ class SphinxContent(Content):
""" Adds a list of index entries the content. """
self.add([".. index:: " + entry for entry in make_lines(entries)])
- def add_definition_item(self, name, lines) -> None:
+ def add_definition_item(self,
+ name: GenericContent,
+ definition: GenericContent,
+ wrap: bool = False) -> None:
""" Adds a definition item the content. """
@contextmanager
def _definition_item_context(content: Content) -> Iterator[None]:
@@ -101,7 +104,10 @@ class SphinxContent(Content):
yield
content.pop_indent()
- self.add(lines, _definition_item_context)
+ if wrap:
+ self.wrap(definition, context=_definition_item_context)
+ else:
+ self.add(definition, context=_definition_item_context)
@contextmanager
def definition_item(self, name: GenericContent) -> Iterator[None]: