Skip to content

Commit 1686b45

Browse files
author
SU2 local assessment
committed
Check site against pending SU2 documentation fixes
1 parent abaa997 commit 1686b45

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

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

Lines changed: 4 additions & 4 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: develop
12+
default: docs/developer-guides
1313

1414
permissions:
1515
contents: read
@@ -32,8 +32,8 @@ jobs:
3232
- name: Checkout SU2 source
3333
uses: actions/checkout@v4
3434
with:
35-
repository: su2code/SU2
36-
ref: ${{ inputs.su2_ref || 'develop' }}
35+
repository: rois1995/SU2
36+
ref: ${{ inputs.su2_ref || 'docs/developer-guides' }}
3737
path: su2
3838
fetch-depth: 0
3939
filter: blob:none
@@ -57,7 +57,7 @@ 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: su2code/SU2
60+
GITHUB_REPOSITORY: rois1995/SU2
6161
BUNDLE_PATH: ${{ github.workspace }}/site/vendor/bundle
6262
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

‎developer-docs/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ The build directory must be separate from both source trees. The build runs the
1414
SU2_SOURCE=/path/to/SU2 python3 -m unittest discover -s developer-docs/tools
1515
```
1616

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.
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 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.

0 commit comments

Comments
 (0)