Prototype initial Doxygen and Sphinx support - #70
Open
ninotarantino wants to merge 19 commits into
Open
Conversation
ninotarantino
force-pushed
the
prototype-doxygen-support
branch
from
August 6, 2026 16:48
076087e to
735af3f
Compare
ninotarantino
had a problem deploying
to
github-pages
August 6, 2026 22:28 — with 
GitHub Actions
Failure
GitHub Actions
Failure
Contributor
Author
|
Note: temporarily allowing this branch to deploy to pages. Revert the settings change in Environments settings after this is merged. |
ninotarantino
had a problem deploying
to
github-pages
August 6, 2026 23:03 — with
GitHub Actions
Failure
GitHub Actions
Failure
ninotarantino
temporarily deployed
to
github-pages
August 6, 2026 23:16 — with
GitHub Actions
Inactive
GitHub Actions
Inactive
ninotarantino
temporarily deployed
to
github-pages
August 7, 2026 02:16 — with
GitHub Actions
Inactive
GitHub Actions
Inactive
ninotarantino
temporarily deployed
to
github-pages
August 7, 2026 14:30 — with
GitHub Actions
Inactive
GitHub Actions
Inactive
There's still an issue with (--) Trick units showing up incorrectly in Sphinx (not Doxygen).
Also started converting some basic documentation to RST and added it to the Sphinx build.
ninotarantino
force-pushed
the
prototype-doxygen-support
branch
from
August 19, 2026 21:58
9833126 to
337645f
Compare
ninotarantino
temporarily deployed
to
github-pages
August 19, 2026 22:00 — with
GitHub Actions
Inactive
GitHub Actions
Inactive
ninotarantino
temporarily deployed
to
github-pages
August 20, 2026 21:29 — with
GitHub Actions
Inactive
GitHub Actions
Inactive
ninotarantino
marked this pull request as ready for review
August 21, 2026 15:57
Collaborator
|
coverage: 89.486% (-0.7%) from 90.223% — prototype-doxygen-support into main |
Contributor
Author
|
The huge decrease in coverage looks to be because the "include condition coverage in aggregate" setting was turned on in Coveralls. Fixed that and will re-generate the report. In the future we'll aim for higher branch coverage anyway, but we'll keep our settings the way they were until a pertinent PR is opened. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Adds initial support for building our documentation using a combination of Doxygen for processing the code and Sphinx for generating the HTML. The Subscriptions and Pointing Reference Frame model documentation were converted in this branch, and other models will follow in future PRs.
This branch is currently deploying to GitHub pages to demo the generated HTML but once this is merged we'll only deploy from
main(note to self, update the project settings).Closes #16