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.

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

Option to include brief comment text with :outline: option #531

Open
pwm1234 opened this issue May 14, 2020 · 1 comment
Open

Option to include brief comment text with :outline: option #531

pwm1234 opened this issue May 14, 2020 · 1 comment
Labels
code Source code enhancement Improvements, additions (also cosmetics)

Comments

@pwm1234
Copy link

pwm1234 commented May 14, 2020

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!

@pwm1234 pwm1234 changed the title Option to include brief command with :outline: option Option to include brief comment text with :outline: option May 14, 2020
@vermeeren
Copy link
Collaborator

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.

@vermeeren vermeeren added code Source code enhancement Improvements, additions (also cosmetics) labels May 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code Source code enhancement Improvements, additions (also cosmetics)
Projects
None yet
Development

No branches or pull requests

2 participants