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

Documentation build in CI #497

Open
dokempf opened this issue Dec 19, 2024 · 2 comments
Open

Documentation build in CI #497

dokempf opened this issue Dec 19, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request sustainable h++ Part of the sustainable HELIOS++ project

Comments

@dokempf
Copy link
Collaborator

dokempf commented Dec 19, 2024

Both the wiki and the Doxygen documentation should be build in CI and be published as a static website to e.g. Github Pages.

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

dokempf commented Jan 22, 2025

Result of the dev meeting on January 25th: Doing this is desirable, but we should double check the following options:

  • How to do versioning in mkdocs
    • Could deploy to with a URL prefix
    • Look into plugins for mkdocs
  • Deploying to RTD - how does it work?

@dokempf
Copy link
Collaborator Author

dokempf commented Jan 22, 2025

Potentially relevant documentation: https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/

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 a pull request may close this issue.

1 participant