Skip to content
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

Jump to bottom

Insert signature name for use with Sphinx ToC #959

Merged
merged 1 commit into from
Jul 30, 2024
Merged

Insert signature name for use with Sphinx ToC #959

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
8 changes: 8 additions & 0 deletions breathe/renderer/sphinxrenderer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -686,6 +686,14 @@ def content(contentnode):
assert len(desc) >= 1
sig = desc[0]
assert isinstance(sig, addnodes.desc_signature)

# Insert the member name for use in Sphinx-generated table of contents.
member_name = node.get_name()
if obj_type == "function":
member_name += "()"
sig.attributes["_toc_name"] = member_name
sig.attributes["_toc_parts"] = member_name

# if may or may not be a multiline signature
isMultiline = sig.get("is_multiline", False)
declarator: Optional[Declarator] = None
Expand Down