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

Setup doxygen and display it in read the docs #478

Closed
burlen opened this issue Sep 29, 2020 · 1 comment · May be fixed by #505
Closed

Setup doxygen and display it in read the docs #478

burlen opened this issue Sep 29, 2020 · 1 comment · May be fixed by #505
Assignees
Labels
2_medium_priority an issue that should be fixed, but is not critical to the next release

Comments

@burlen
Copy link
Collaborator

burlen commented Sep 29, 2020

set up doxygen and display it on read the docs. there will be some configuration needed to tell doxygen to parse our code. We probably will need to make a pass over the headers to add more mark up, but the idea here is just to get something on the screen.
See also: https://www.doxygen.nl/index.html

the breathe project seems to a good starting point for displaying in rtd. if it turns out that there are major issues with breathe we can evaluate other options.
See also https://breathe.readthedocs.io/en/latest/

@burlen burlen added the 2_medium_priority an issue that should be fixed, but is not critical to the next release label Sep 29, 2020
@burlen
Copy link
Collaborator Author

burlen commented May 6, 2021

done. thanks @elbashandy

@burlen burlen closed this as completed May 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2_medium_priority an issue that should be fixed, but is not critical to the next release
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants