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

Add documentation to GH pages #74

Merged
merged 1 commit into from
Nov 22, 2024
Merged

Add documentation to GH pages #74

merged 1 commit into from
Nov 22, 2024

Conversation

Matthew-Whitlock
Copy link
Collaborator

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:

  • More process recovery description
  • (optional) better formatting, particularly of the long-form descriptions for Process/Data recovery

Adding documentation to the internal functions can be more ad-hoc for now

@Matthew-Whitlock
Copy link
Collaborator Author

I should swap 'make doc' to 'make docs'

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 Matthew-Whitlock merged commit 7c58ad8 into develop Nov 22, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant