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

CI documentation building + GitHub Pages deployment #503

Closed
wants to merge 2 commits into from
Closed

Conversation

dokempf
Copy link
Collaborator

@dokempf dokempf commented Jan 13, 2025

This PR adds a CI workflow for:

  • Building the mkdocs documentation from the Wiki repository
  • Integrating the Doxygen documentation into that doc
  • Deploy it to GitHub pages

The workflow currently triggers off the main branch, so we would always document the latest release on the website.

What is missing so far, is adding links to the README etc. I postponed this until we have a decision on the exact URL.

This fixes #497.

Copy link
Contributor

@han16nah han16nah left a comment

Choose a reason for hiding this comment

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

lgtm 👍

@dokempf dokempf added documentation Improvements or additions to documentation enhancement New feature or request sustainable h++ Part of the sustainable HELIOS++ project labels Jan 13, 2025
@dokempf
Copy link
Collaborator Author

dokempf commented Jan 13, 2025

Maybe we should wait for discussion at the dev meeting under which URL we want to publish this. Until then, the deployed docs from my fork serve as a demonstrator of this PR: https://dokempf.github.io/helios/

@han16nah han16nah deleted the branch dev January 24, 2025 15:14
@han16nah han16nah closed this Jan 24, 2025
@dokempf dokempf mentioned this pull request Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request sustainable h++ Part of the sustainable HELIOS++ project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation build in CI
2 participants