Skip to content

Commit 48fa1a5

Browse files
authored
Merge branch 'main' into doc/nitpick
2 parents 3ef8377 + 38437e6 commit 48fa1a5

File tree

4,555 files changed

+214756
-176026
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

4,555 files changed

+214756
-176026
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# These owners will be the default owners for everything in the repo. Unless a
22
# later match takes precedence, the PySTK team will be requested for review when
33
# someone opens a pull request.
4-
* @ansys-internal/pystk-team
4+
* @ansys-internal/pystk-approvers

.github/dependabot.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ updates:
77
labels:
88
- "dependencies:pyproject"
99
commit-message:
10-
prefix: "maint"
10+
prefix: "build"
1111
groups:
1212
tests:
1313
patterns:
@@ -34,7 +34,7 @@ updates:
3434
labels:
3535
- "dependencies:ci"
3636
commit-message:
37-
prefix: "maint"
37+
prefix: "build"
3838
groups:
3939
actions:
4040
patterns:

.github/workflows/ci_cd_main.yml

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ on:
55
- main
66

77
env:
8-
MAIN_PYTHON_VERSION: '3.12'
8+
MAIN_PYTHON_VERSION: '3.13'
99
DOCUMENTATION_CNAME: 'stk.docs.pyansys.com'
1010

1111
concurrency:
@@ -20,10 +20,21 @@ jobs:
2020
timeout-minutes: 30
2121
steps:
2222

23-
- name: "Build project documentation excluding 'API' and 'Example' sections"
24-
uses: ansys/actions/doc-build@v7
23+
- name: "Checkout project"
24+
uses: actions/checkout@v4
25+
26+
- name: "Install Python ${{ env.MAIN_PYTHON_VERSION }}"
27+
uses: actions/setup-python@v5
2528
with:
2629
python-version: ${{ env.MAIN_PYTHON_VERSION }}
30+
31+
- name: "Install Tox"
32+
run: |
33+
python -m pip install tox
34+
35+
- name: "Build project documentation excluding 'API' and 'Example' sections"
36+
run: |
37+
tox -e doc-links,doc-html
2738
env:
2839
BUILD_API: false
2940
BUILD_EXAMPLES: false
@@ -34,17 +45,19 @@ jobs:
3445
ref: "gh-pages"
3546
path: "gh-pages"
3647

37-
- name: "Include 'API' and 'Examples' sections from nightly build docs"
48+
- name: "Reuse heavy content from nightly build"
3849
run: |
50+
# Copy wheelhouse artifacts
51+
cp -r gh-pages/version/dev/_static/wheelhouse doc/_build/html/_static/wheelhouse
3952
# Copy landing pages for 'API' and 'Examples' sections
4053
cp gh-pages/version/dev/api.html doc/_build/html/api.html
4154
cp gh-pages/version/dev/examples.html doc/_build/html/examples.html
4255
# Copy content pages for 'API' and 'Examples' sections
4356
cp -r gh-pages/version/dev/api doc/_build/html/api
4457
cp -r gh-pages/version/dev/examples doc/_build/html/examples
4558
cp -r gh-pages/version/dev/_images/* doc/_build/html/_images
46-
# Copy landing page to include links to previous sections
47-
cp gh-pages/version/dev/index.html doc/_build/html/index.html
59+
# Copy static search content
60+
cp gh-pages/version/dev/_static/search.json doc/_build/html/_static/search.json
4861
4962
- name: "Upload combined artifacts"
5063
uses: actions/upload-artifact@v4
@@ -57,8 +70,10 @@ jobs:
5770
runs-on: ubuntu-latest
5871
needs: doc-build
5972
steps:
60-
- uses: ansys/actions/doc-deploy-dev@v7
73+
- uses: ansys/actions/doc-deploy-dev@v8
6174
with:
6275
doc-artifact-name: "complete-documentation-html"
6376
cname: ${{ env.DOCUMENTATION_CNAME }}
6477
token: ${{ secrets.GITHUB_TOKEN }}
78+
bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
79+
bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}

.github/workflows/ci_cd_night.yml

Lines changed: 47 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ on:
2424
- cron: '0 0 * * 6,0'
2525

2626
env:
27+
LIBRARY_NAME: 'ansys-stk-core'
2728
MAIN_PYTHON_VERSION: '3.12'
2829
DOCUMENTATION_CNAME: 'stk.docs.pyansys.com'
2930
STK_DOCKER_IMAGE: 'ansys/stk:dev-ubuntu22.04'
@@ -37,15 +38,43 @@ concurrency:
3738

3839
jobs:
3940

41+
build-wheelhouse:
42+
name: "Build wheelhouse for latest Python versions"
43+
runs-on: ${{ matrix.os }}
44+
strategy:
45+
matrix:
46+
os: [ubuntu-latest, windows-latest]
47+
python-version: ['3.11', '3.12', '3.13']
48+
target: ['all', 'grpc', 'visualization']
49+
steps:
50+
- name: "Build a wheelhouse of the Python library"
51+
uses: ansys/actions/build-wheelhouse@v8
52+
with:
53+
library-name: ${{ env.LIBRARY_NAME }}
54+
operating-system: ${{ matrix.os }}
55+
python-version: ${{ matrix.python-version }}
56+
target: ${{ matrix.target }}
57+
4058
doc-build:
4159
name: "Doc build"
4260
runs-on: [self-hosted, pystk]
4361
timeout-minutes: 90
62+
needs: "build-wheelhouse"
4463
steps:
4564

4665
- name: "Checkout the project"
4766
uses: actions/checkout@v4
4867

68+
- name: "Download wheelhouse into static path"
69+
uses: actions/download-artifact@v4
70+
with:
71+
path: "doc/source/_static/wheelhouse"
72+
pattern: "*-wheelhouse-*"
73+
74+
- name: "Display the wheelhouse layout"
75+
run: |
76+
tree doc/source/_static/wheelhouse
77+
4978
- name: "Generate the name of the Docker image and the container"
5079
run: |
5180
python_image_name=${{ env.STK_DOCKER_IMAGE }}-python${{ env.MAIN_PYTHON_VERSION }}
@@ -120,14 +149,18 @@ jobs:
120149
if: inputs.run-tests || github.event_name == 'schedule'
121150
strategy:
122151
matrix:
123-
python: ["3.10", "3.11", "3.12"]
152+
# TODO: restore support for Python 3.13
153+
# https://github.com/ansys-internal/pystk/issues/557
154+
python: ["3.11", "3.12"]
124155
is-weekly-run:
125156
- ${{ github.event_name == 'schedule' && github.event.schedule == '0 0 * * 1-5' }}
126157
exclude:
127-
- is-weekly-run: true
128-
python: "3.10"
129158
- is-weekly-run: true
130159
python: "3.11"
160+
# TODO: restore support for Python 3.13
161+
# https://github.com/ansys-internal/pystk/issues/557
162+
#- is-weekly-run: true
163+
# python: "3.12"
131164
fail-fast: false
132165
steps:
133166

@@ -186,6 +219,13 @@ jobs:
186219
${{ env.STK_CONTAINER }} /bin/bash -c \
187220
"export COVERAGE_FILE=vgt && tox -e tests-vgt-graphics-cov-linux"
188221
222+
- name: "Run the doc snippet tests"
223+
run: |
224+
docker exec \
225+
--workdir ${{ env.PYSTK_DIR }} \
226+
${{ env.STK_CONTAINER }} /bin/bash -c \
227+
"export COVERAGE_FILE=snippets && tox -e tests-snippets-graphics-cov-linux"
228+
189229
- name: "Install coverage dependencies"
190230
if: ${{ matrix.python == env.MAIN_PYTHON_VERSION }}
191231
run: |
@@ -200,7 +240,7 @@ jobs:
200240
docker exec \
201241
--workdir ${{ env.PYSTK_DIR }} \
202242
${{ env.STK_CONTAINER }} /bin/bash -c \
203-
"coverage combine aviator stknogfx stkgfx vgt"
243+
"coverage combine aviator stknogfx stkgfx vgt snippets"
204244
205245
- name: "Generate total coverage report"
206246
if: ${{ matrix.python == env.MAIN_PYTHON_VERSION }}
@@ -229,7 +269,9 @@ jobs:
229269
runs-on: ubuntu-latest
230270
needs: doc-build
231271
steps:
232-
- uses: ansys/actions/doc-deploy-dev@v7
272+
- uses: ansys/actions/doc-deploy-dev@v8
233273
with:
234274
cname: ${{ env.DOCUMENTATION_CNAME }}
235275
token: ${{ secrets.GITHUB_TOKEN }}
276+
bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
277+
bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}

0 commit comments

Comments
 (0)