Thanks to visit codestin.com
Credit goes to Github.com

Skip to content

Add GitHub Pages Documentation CI #272

Merged
pfluegdk merged 10 commits intomasterfrom
add_github_pages_doc
Feb 24, 2025
Merged

Add GitHub Pages Documentation CI #272
pfluegdk merged 10 commits intomasterfrom
add_github_pages_doc

Conversation

@G-071
Copy link
Member

@G-071 G-071 commented Feb 13, 2025

Problem this PR addresses:

Currently, our documentation is residing at three different locations:

  • We have the Doxygen documentation directly in our repository. This is our most up-to-date documentation. However, it requires our users to build it themselves using a local copy and Doxygen.
  • We do have an online version for our Doxygen documentation at https://sgpp.sparsegrids.org/docs/, but it is horribly out of date (2019) and currently features not automatic updates.
  • We have some documentation in our Wiki (https://github.com/SGpp/SGpp/wiki). This documentation includes usage examples (copied from our doxygen), as well as build instruction that can only be found in the Wiki so far (so it is not entirely duplicated). Worse, the math symbols got messed up in the tutorials (see for example https://github.com/SGpp/SGpp/wiki/Base-quick-start-(Python) ).

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).

@G-071 G-071 requested a review from pfluegdk February 13, 2025 15:14
Copy link
Member

@pfluegdk pfluegdk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to merge

@pfluegdk pfluegdk merged commit 1b39755 into master Feb 24, 2025
6 checks passed
@pfluegdk pfluegdk deleted the add_github_pages_doc branch February 24, 2025 09:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants