Skip to content

Move developer guides and reference generation to the website - #232

Open
rois1995 wants to merge 3 commits into
su2code:developfrom
rois1995:docs/developer-guides-site
Open

rois1995 wants to merge 3 commits into
su2code:developfrom
rois1995:docs/developer-guides-site

Conversation

@rois1995

@rois1995 rois1995 commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

This adds the developer guides and reference generator to the website repository. The documentation check fetches SU2 source for the generated references.

Merge SU2 PR #2992 first: its configuration and flamelet documentation corrections are needed by the website checks. The check temporarily uses the SU2 PR branch; after that PR merges, switch it to upstream develop and verify the checks before merging this PR.

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

@rois1995
rois1995 marked this pull request as ready for review November 12, 2026 09:21

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant