breathe
breathe copied to clipboard
Option to include brief comment text with :outline: option
I am trying to use breathe to produce a User Manual for my code. One piece of documentation I would like to have is an overview of a class and namespace. The :outline: option almost does what I want, but it falls short because there is no way to also get the brief documentation string from the doxygen comments. This is important because I do not want to replicate the brief comment from the C++ comments in the rst documentation.
Since I have not been able to figure out how to do this with the current breathe implementation I am make this issue/request. I am a reasonably competent python programmer, but I am not familiar with sphinx extensions. If this request sounds reasonable and someone can outline a solution, I am willing to try to implement an solution and submit a PR.
Thanks!
Perhaps recent PR #501 will help understand Breathe a bit, I think adding a :sections:
for other directives for cover more specific special use cases like the one you currently have.