Repository navigation
Move developer guides and reference generation to the website - #232
Merged
Merged
Conversation
rois1995
marked this pull request as ready for review
November 12, 2026 09:21
5 of 6 tasks
rois1995
added a commit
to su2code/SU2
that referenced
this pull request
Nov 21, 2026
…notes (#2992) ## Proposed Changes Correct outdated settings in `config_template.cfg` and the flamelet boundary-condition notes. The CFD algorithms are unchanged. ## Related Work and Merge Order Merge this PR before [website PR #232](su2code/su2code.github.io#232). The website's reference checks need the corrections in this PR. Once this PR is merged, switch the website PR's CI from the temporary SU2 fork branch to upstream `develop` and verify the checks before merging it. The developer guides and reference generator have moved to the website PR. The related user guides, search and navigation are in [website PR #222](su2code/su2code.github.io#222). ## PR Checklist - [x] I am submitting my contribution to the develop branch. - [ ] My contribution generates no new compiler warnings (try with --warnlevel=3 when using meson). - [x] My contribution is commented and consistent with SU2 style (https://su2code.github.io/docs_v7/Style-Guide/). - [x] I used the pre-commit hook to prevent dirty commits and used `pre-commit run --all` to format old commits. - [x] I have added a test case that demonstrates my contribution, if necessary. - [x] I have updated appropriate documentation (Tutorials, Docs Page, config_template.cpp), if necessary. [Combined website preview](https://rois1995.github.io/SU2/) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: SU2 local assessment <local-assessment@invalid>
SU2 PR #2992 is merged, so the temporary SU2 fork branch is no longer needed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_013BK58iC1x1atmaCvSH4WtN
bigfooted
approved these changes
Nov 21, 2026
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.
This adds the developer guides and reference generator to the website repository. The documentation check fetches SU2 source for the generated references.
SU2 PR #2992 is merged: its configuration and flamelet documentation corrections are needed by the website checks. The check now uses upstream SU2
developand passes.Validation: 18 Python tests passed against the SU2 PR checkout; the generator ran successfully on a staged website. The full Jekyll and Doxygen build has not been run locally because the required Ruby and Bundler versions are unavailable. The documentation workflow checks the full build.
Combined website preview