Skip to content

Commit abaa997

Browse files
author
Rois
committed
Move developer documentation and generator to website
1 parent 02b63fb commit abaa997

24 files changed

Lines changed: 8887 additions & 6 deletions

‎.github/workflows/docs-check.yml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ on:
99
inputs:
1010
su2_ref:
1111
description: SU2 commit SHA or branch
12-
default: docs/developer-guides
12+
default: develop
1313

1414
permissions:
1515
contents: read
@@ -29,11 +29,11 @@ jobs:
2929
fetch-depth: 0
3030
filter: blob:none
3131
persist-credentials: false
32-
- name: Checkout SU2 documentation tools
32+
- name: Checkout SU2 source
3333
uses: actions/checkout@v4
3434
with:
35-
repository: rois1995/SU2
36-
ref: ${{ inputs.su2_ref || 'docs/developer-guides' }}
35+
repository: su2code/SU2
36+
ref: ${{ inputs.su2_ref || 'develop' }}
3737
path: su2
3838
fetch-depth: 0
3939
filter: blob:none
@@ -57,9 +57,9 @@ jobs:
5757
run: sudo apt-get update && sudo apt-get install -y doxygen graphviz
5858
- name: Build and check website
5959
env:
60-
GITHUB_REPOSITORY: rois1995/SU2
60+
GITHUB_REPOSITORY: su2code/SU2
6161
BUNDLE_PATH: ${{ github.workspace }}/site/vendor/bundle
62-
run: python3 su2/Docs/website/tools/build_docs.py --su2 su2 --site site --build-dir "$RUNNER_TEMP/docs-site" --baseurl /SU2 --mark-changes
62+
run: python3 site/developer-docs/tools/build_docs.py --su2 su2 --site site --build-dir "$RUNNER_TEMP/docs-site" --baseurl /SU2 --mark-changes
6363
- name: Upload checked preview
6464
uses: actions/upload-artifact@v4
6565
with:

‎developer-docs/README.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Developer documentation
2+
3+
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.
4+
5+
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:
6+
7+
```sh
8+
python3 developer-docs/tools/build_docs.py --su2 /path/to/SU2 --site . --build-dir /path/to/empty-build --baseurl /SU2
9+
```
10+
11+
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:
12+
13+
```sh
14+
SU2_SOURCE=/path/to/SU2 python3 -m unittest discover -s developer-docs/tools
15+
```
16+
17+
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 SU2 develop and records the revisions used. External links and numerical convergence are not checked.

‎developer-docs/pages/Adding-Output-Fields.md‎

Lines changed: 280 additions & 0 deletions
Large diffs are not rendered by default.

‎developer-docs/pages/Adding-a-Boundary-Condition.md‎

Lines changed: 559 additions & 0 deletions
Large diffs are not rendered by default.

‎developer-docs/pages/Adding-a-Config-Option.md‎

Lines changed: 349 additions & 0 deletions
Large diffs are not rendered by default.

‎developer-docs/pages/Adding-a-Fluid-Model.md‎

Lines changed: 433 additions & 0 deletions
Large diffs are not rendered by default.

‎developer-docs/pages/Adding-a-Numerical-Scheme.md‎

Lines changed: 533 additions & 0 deletions
Large diffs are not rendered by default.

‎developer-docs/pages/Adding-a-Solver.md‎

Lines changed: 719 additions & 0 deletions
Large diffs are not rendered by default.

‎developer-docs/pages/Adding-a-Transition-Model.md‎

Lines changed: 502 additions & 0 deletions
Large diffs are not rendered by default.

‎developer-docs/pages/Adding-a-Turbulence-Model.md‎

Lines changed: 751 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)