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

Set up Doxygen document generation #60

Closed
mysterymath opened this issue Jul 16, 2022 · 2 comments
Closed

Set up Doxygen document generation #60

mysterymath opened this issue Jul 16, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation p1

Comments

@mysterymath
Copy link
Contributor

We should really have a documentation generator in place before we really start filling out the SDK.

I did a quick survey, and it looks like there's two big games in town: Doxygen and Sphinx. Sphinx has the benefit of free hosting on ReadTheDocs. We should try to set this up for our SDK.
@mysterymath mysterymath added documentation Improvements or additions to documentation p2 labels Jul 16, 2022
@mysterymath mysterymath added p1 and removed p2 labels Jul 27, 2022
@mysterymath mysterymath changed the title Set up Sphinx document generation Set up Doxygen document generation Aug 2, 2022
@mysterymath
Copy link
Contributor Author

Looks like Sphinx uses Doxygen for C++, so that pretty much settles that.

@mysterymath
Copy link
Contributor Author

Done. SDK Doxygen is now built in CI and available under https://llvm-mos.github.io/llvm-mos-sdk/files.html as the SDK's Github Pages page. The branch used for the docs is gh-pages.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation p1
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mysterymath