Add ability to generate API reference docs with Doxygen #96
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
crandmck
changed the title
gpeacock
approved these changes
Sep 18, 2025
crandmck
had a problem deploying
to
github-pages
GitHub Actions
Failure
crandmck
had a problem deploying
to
github-pages
GitHub Actions
Failure
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a script to generate API reference docs using Doxygen.
NOTE: The generated HTML docs are not committed to the repo in this PR.
To do this properly, we need to add a GH worfkow similar to this https://github.com/creator-assertions/creator-assertions.github.io/blob/main/.github/workflows/publish.yml, which will build the docs using Sphinx and deploy them to GH Pages for consumption. We can then link to that from the OS doc site.