Merged
Conversation
pfluegdk
reviewed
Feb 24, 2025
Co-authored-by: Dirk Pflüger <[email protected]>
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
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.
Problem this PR addresses:
Currently, our documentation is residing at three different locations:
This is hardly ideal and, in the case of missing math symbols and the out-of-date documentation, rather confusing.
Solution:
I think it is best if we unify these three locations using GitHub pages and our existing Doxygen setup within the code.
This PR adds a new CI pipeline that builds the current Doxygen documentation and pushes it to https://sgpp.github.io/SGpp/ for every commit to master. This way, the documentation is always up-to-date (and the math symbols are displayed correctly).
Next Steps:
I think the next steps should be to move the extra build information from the Wiki to the Doxygen documentation so we have everything in one place. This is also a good opportunity to add build instructions for using our Spack package. I also think we should remove the obsolete documentation from https://sgpp.sparsegrids.org and rather use this site for sgpp-related news, blog posts and publications (not for the code/build documentation).