Repository navigation
Conversation
Add Docs/website: a script that generates the configuration option reference from CConfig.cpp, checks the options named in the docs and copies the pages kept with the code into the website. A workflow builds the website with Jekyll and Doxygen and publishes it on GitHub Pages. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
… fork New pages: Code Structure, Running Regression Tests, Adding a Config Option and Adding Output Fields, written against develop 11c177b. The workflow builds the website from rois1995/su2code.github.io (branch docs_site) by default and keeps Docs/website out of Doxygen. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
…eference The generator now reads option comments that start with /* as well as /*!, uses the config_template.cfg comment when it adds information, links each option to the website pages that name it and to test case files that use it, and lists weakly documented options on the Docs Check page. Markdown pages kept in the code folders are added to the user guide, and links to the code point to the repository that is built. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
New pages: adding a boundary condition, numerical scheme, fluid model, turbulence model, transition model and solver (with a section on non-conservative systems), in their own menu section. All developer pages and the README were rewritten in plain language. The docs check skips source-code blocks and C++ names written as inline code. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
…coverage The Output Fields Reference lists the history and volume fields of each output class from the AddHistoryOutput/AddVolumeOutput calls. The Docs Check page now lists developer pages whose named code files changed since their "Last checked against" commit, the share of classes with a Doxygen comment and group, and the Doxygen warnings. The workflow runs Doxygen first and fetches the history without file contents. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
build_site.py --mark-changes compares the website with the official one and adds a script that colours the changed and generated pages, and the new menu sections, in red. The test workflow turns it on. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
Users copy config_template.cfg, so a name the code does not register stops their run. The check found eight such names. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
Error Messages lists every SU2_MPI::Error message with the options it names and a link to the code. Renamed and Removed Options lists the options of the releases since v7.0.0 that the code no longer has, with the message SU2 prints for them. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NSfEWrhpF27TnrkJH74sv8
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_013YFdgQwrRqCQ2ihG446aNe
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Contributor
|
@rois1995 should this go on su2code.github.io? |
Contributor
Author
|
Yes, I think that makes sense. The developer guides and website generation tools could live in su2code.github.io alongside the other documentation. The build would still need to fetch the SU2 source to generate the option, output and error references. The corrections to config_template.cfg and the flamelet note would stay here. |
This branch has not been deployed
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.
Proposed Changes
Correct outdated settings in
config_template.cfgand the flamelet boundary-condition notes. The CFD algorithms are unchanged.Related Work and Merge Order
Merge this PR before website PR #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
developand 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.
PR Checklist
pre-commit run --allto format old commits.Combined website preview