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

Add documentation for breathe-apidoc #776

Open
samuel-emrys opened this issue Dec 16, 2021 · 1 comment · May be fixed by #920
Open

Add documentation for breathe-apidoc #776

samuel-emrys opened this issue Dec 16, 2021 · 1 comment · May be fixed by #920
Labels
documentation Generated html, changelog, inline comments

Comments

@samuel-emrys
Copy link

There's currently no documentation for breathe-apidoc. This is a critical utility for automated documentation generation and should have it's options documented. I noticed that this is a common complaint, notably identified in #293 and #357. I thought I'd raise this for more discrete tracking of this issue - as it stands it wasn't obvious to me that this task was on the to-do list.
@vermeeren vermeeren added the documentation Generated html, changelog, inline comments label Dec 18, 2021
@vermeeren
Copy link
Collaborator

@samuel-emrys Yeah it's been on the TODO for very long by now, all it has now is --help's output but no doc or mention anywhere else afaik.

Patches very welcome.

@HealthyPear HealthyPear linked a pull request May 17, 2023 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Generated html, changelog, inline comments
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add documentation for breathe-apidoc HealthyPear/breathe
2 participants
@vermeeren @samuel-emrys