Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/workflows/docs-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ on:
inputs:
su2_ref:
description: SU2 commit SHA or branch
default: docs/developer-guides
default: develop

permissions:
contents: read
Expand All @@ -29,11 +29,11 @@ jobs:
fetch-depth: 0
filter: blob:none
persist-credentials: false
- name: Checkout SU2 documentation tools
- name: Checkout SU2 source
uses: actions/checkout@v4
with:
repository: rois1995/SU2
ref: ${{ inputs.su2_ref || 'docs/developer-guides' }}
repository: su2code/SU2
ref: ${{ inputs.su2_ref || 'develop' }}
path: su2
fetch-depth: 0
filter: blob:none
Expand All @@ -59,7 +59,7 @@ jobs:
env:
GITHUB_REPOSITORY: rois1995/SU2
BUNDLE_PATH: ${{ github.workspace }}/site/vendor/bundle
run: python3 su2/Docs/website/tools/build_docs.py --su2 su2 --site site --build-dir "$RUNNER_TEMP/docs-site" --baseurl /SU2 --mark-changes
run: python3 site/developer-docs/tools/build_docs.py --su2 su2 --site site --build-dir "$RUNNER_TEMP/docs-site" --baseurl /SU2 --mark-changes
- name: Upload checked preview
uses: actions/upload-artifact@v4
with:
Expand Down
17 changes: 17 additions & 0 deletions developer-docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Developer documentation

The developer guides and website tools live in this repository. The generator reads an SU2 checkout to produce configuration, output, error and migration references and copies selected notes from the source tree. It stages the site without changing either checkout.

To build locally, install Python 3.8+, Git, Ruby and Bundler versions specified by the website, Doxygen and Graphviz, and install the locked gems. From the website root, run:

```sh
python3 developer-docs/tools/build_docs.py --su2 /path/to/SU2 --site . --build-dir /path/to/empty-build --baseurl /SU2
```

The build directory must be separate from both source trees. The build runs the Python tests, generates the references and Doxygen, builds Jekyll and checks the result. To run the Python tests alone:

```sh
SU2_SOURCE=/path/to/SU2 python3 -m unittest discover -s developer-docs/tools
```

Edit the guides in `developer-docs/pages`; generated pages are built from SU2 and should not be edited directly. The documentation checks workflow builds a preview with the SU2 documentation branch and records the revisions used; switch it to SU2 develop after the source corrections in SU2 PR #2992 merge. External links and numerical convergence are not checked.
280 changes: 280 additions & 0 deletions developer-docs/pages/Adding-Output-Fields.md

Large diffs are not rendered by default.

559 changes: 559 additions & 0 deletions developer-docs/pages/Adding-a-Boundary-Condition.md

Large diffs are not rendered by default.

349 changes: 349 additions & 0 deletions developer-docs/pages/Adding-a-Config-Option.md

Large diffs are not rendered by default.

433 changes: 433 additions & 0 deletions developer-docs/pages/Adding-a-Fluid-Model.md

Large diffs are not rendered by default.

533 changes: 533 additions & 0 deletions developer-docs/pages/Adding-a-Numerical-Scheme.md

Large diffs are not rendered by default.

719 changes: 719 additions & 0 deletions developer-docs/pages/Adding-a-Solver.md

Large diffs are not rendered by default.

502 changes: 502 additions & 0 deletions developer-docs/pages/Adding-a-Transition-Model.md

Large diffs are not rendered by default.

751 changes: 751 additions & 0 deletions developer-docs/pages/Adding-a-Turbulence-Model.md

Large diffs are not rendered by default.

745 changes: 745 additions & 0 deletions developer-docs/pages/Automatic-Differentiation.md

Large diffs are not rendered by default.

25 changes: 25 additions & 0 deletions developer-docs/pages/Code-Reference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: Code Reference (Doxygen)
permalink: /docs_v7/Code-Reference/
---

The code reference describes the classes and files of SU2. [Doxygen](https://www.doxygen.nl) makes it from the comments in the source code.
It is rebuilt each time the code changes, so it always matches the code.

**[Open the code reference]({{ "/doxygen/index.html" | relative_url }})**

Good places to start:

- [Class list]({{ "/doxygen/annotated.html" | relative_url }}): all classes, with their parents and children.
- [File list]({{ "/doxygen/files.html" | relative_url }}): all source files.
- `CDriver`: runs the simulation and creates all the other objects.
- `CConfig`: reads the configuration file. The [Option Reference](../Option-Reference/) is made from it.
- `CSolver`, `CNumerics`, `CVariable`, `CGeometry`: the solvers, the numerical schemes, the stored variables and the mesh.

To build it on your computer, run this command in the SU2 folder. Then open `Docs/html/index.html`.

```
doxygen doxyfile
```

Last checked against SU2 develop `11c177b904`.
369 changes: 369 additions & 0 deletions developer-docs/pages/Code-Structure.md

Large diffs are not rendered by default.

Loading
Loading