-
-
Notifications
You must be signed in to change notification settings - Fork 211
Open
Description
Hi folks!
First, my thanks to everyone who's been involved in keeping this project going since Michael's project status announcement in July 2024.
I recently rebuilt the docs for my project and found messy results in going from breathe 4.35 to 4.36. Specifically, the TOC gets polluted with members of enums and structs. Here's an after-and-before screenshot showing how this manifests in my project.
My issue is fixed if I check out 4.36 from source, and delete the following lines:
breathe/breathe/renderer/sphinxrenderer.py
Lines 917 to 925 in 9a1c653
| # Insert the member name for use in Sphinx-generated table of contents. | |
| if isinstance(node, parser.Node_compounddefType): | |
| member_name = node.compoundname | |
| else: | |
| member_name = node.name | |
| if obj_type == "function": | |
| member_name += "()" | |
| sig.attributes["_toc_name"] = member_name | |
| sig.attributes["_toc_parts"] = member_name |
I'd open a PR removing these lines, but I'd like to know what the motivation was for adding them.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels