Add documentation to GH pages #74
Merged
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
Collaborator
Author
|
I should swap 'make doc' to 'make docs' |
Matthew-Whitlock
force-pushed
the
doxygen
branch
from
fc14025 to
9c30fda
Compare
Documentation Organize, setup versioned docs Deploy docs to Github pages Update doxygen header Use Doxygen 1.12.0 for github pages builds Improved Process Recovery docs writeup 'make doc' -> 'make docs'
Matthew-Whitlock
force-pushed
the
doxygen
branch
from
9c30fda to
e0ce1f8
Compare
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.
Adds Doxygen documentation for main API. Published to Github pages: https://sandialabs.github.io/Fenix
This should allow the dropdown in the top-left to switch between versions (currently only this doxygen branch is built, but we'll build for master and develop once this merges in)
TODO:
Adding documentation to the internal functions can be more ad-hoc for now