8000 Splice out parameter direction in field lists by jakobandersen · Pull Request #675 · breathe-doc/breathe · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Splice out parameter direction in field lists #675

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 22, 2021
Merged

Splice out parameter direction in field lists #675

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 32 additions & 11 deletions breathe/renderer/sphinxrenderer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2066,21 +2066,44 @@ def visit_docparamlist(self, node) -> List[Node]:
# https://docutils.sourceforge.io/docs/ref/doctree.html#field-list
fieldList = nodes.field_list()
for item in node.parameteritem:
# TODO: does item.parameternamelist really have more than 1 parametername?
assert len(item.parameternamelist) <= 1, item.parameternamelist
nameNodes = []
parameterDirectionNodes = []
if len(item.parameternamelist) != 0:
paramNameNodes = item.parameternamelist[0].parametername
# TODO: how many elements can paramNameNodes have?
assert len(paramNameNodes) <= 1, paramNameNodes
if len(paramNameNodes) != 0:
content = paramNameNodes[0].content_
# this is really a list of MixedContainer objects, i.e., a generic object
# we assume there is either 1 or 2 elements, if there is 2 the first is the
# parameter direction
assert len(content) == 1 or len(content) == 2, content
nameNodes = self.render(content[-1])
if len(content) == 2:
dir = ''.join(n.astext() for n in self.render(content[0])).strip()
assert dir in ('[in]', '[out]', '[inout]'), ">" + dir + "<"
parameterDirectionNodes = [
nodes.strong(dir, dir),
nodes.Text(' ', ' ')
]

name = nodes.field_name(
'', nodes.Text(fieldListName[node.kind] + ' '),
*self.render_iterable(item.parameternamelist))
body = nodes.field_body('', *self.render_optional(item.parameterdescription))
*nameNodes)
bodyNodes = self.render_optional(item.parameterdescription)
# TODO: is it correct that bodyNodes is either empty or a single paragraph?
assert len(bodyNodes) <= 1, bodyNodes
if len(bodyNodes) == 1:
assert isinstance(bodyNodes[0], nodes.paragraph)
bodyNodes = [nodes.paragraph(
'', '', *(parameterDirectionNodes + bodyNodes[0].children))]
body = nodes.field_body('', *bodyNodes)
field = nodes.field('', name, body)
fieldList += field
return [fieldList]

def visit_docparamnamelist(self, node) -> List[Node]:
""" Parameter Name Renderer"""
return self.render_iterable(node.parametername)

def visit_docparamname(self, node) -> List[Node]:
return self.render_iterable(node.content_)

def visit_templateparamlist(self, node) -> List[Node]:
nodelist = [] # type: List[Node]
self.output_defname = False
Expand Down Expand Up @@ -2163,8 +2186,6 @@ def dispatch_memberdef(self, node) -> List[Node]:
"description": visit_description,
"param": visit_param,
"docparamlist": visit_docparamlist,
"docparamnamelist": visit_docparamnamelist,
"docparamname": visit_docparamname,
"templateparamlist": visit_templateparamlist,
"docxrefsect": visit_docxrefsect,
"docvariablelist": visit_docvariablelist,
Expand Down
0