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

Include doxygen documentation in sphinx #88

Open
schmoelder opened this issue Jun 21, 2021 · 0 comments · May be fixed by #89
Open

Include doxygen documentation in sphinx #88

schmoelder opened this issue Jun 21, 2021 · 0 comments · May be fixed by #89
Assignees
@schmoelder
Labels
documentation

Comments

@schmoelder
Copy link
Contributor

The CADET code itself is documented using doxygen.

We should include this part in the CADET documentation using the sphinx extensions breathe and/or exhale (a wrapper around breathe).

This could also be the foundation for a developer's guide.

Open issue: There seems to be an issue with exhale when using @todo in the documentation (see here).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@schmoelder schmoelder

Labels
documentation
Projects
CADET-Project
Status: Todo
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Include Doxygen build cadet/CADET-Core
1 participant
@schmoelder